Universal CMDB. Software Version: Administration Guide

Transcription

1 Universal CMDB Sftware Versin: Administratin Guide Dcument Release Date: December 2016 Sftware Release Date: December 2016

2 Legal Ntices Warranty The nly warranties fr Hewlett Packard Enterprise prducts and services are set frth in the express warranty statements accmpanying such prducts and services. Nthing herein shuld be cnstrued as cnstituting an additinal warranty. Hewlett Packard Enterprise shall nt be liable fr technical r editrial errrs r missins cntained herein. The infrmatin cntained herein is subject t change withut ntice. Restricted Rights Legend Cnfidential cmputer sftware. Valid license frm Hewlett Packard Enterprise required fr pssessin, use r cpying. Cnsistent with FAR and , Cmmercial Cmputer Sftware, Cmputer Sftware Dcumentatin, and Technical Data fr Cmmercial Items are licensed t the U.S. Gvernment under vendr's standard cmmercial license. Cpyright Ntice Hewlett Packard Enterprise Develpment LP Trademark Ntices Adbe is a trademark f Adbe Systems Incrprated. Micrsft and Windws are U.S. registered trademarks f Micrsft Crpratin. UNIX is a registered trademark f The Open Grup. Dcumentatin Updates T check fr recent updates r t verify that yu are using the mst recent editin f a dcument, g t: This site requires that yu register fr an HP Passprt and t sign in. T register fr an HP Passprt ID, click Register n the HPE Sftware Supprt site r click Create an Accunt n the HP Passprt lgin page. Yu will als receive updated r new editins if yu subscribe t the apprpriate prduct supprt service. Cntact yur HPE sales representative fr details. Supprt Visit the HPE Sftware Supprt site at: This website prvides cntact infrmatin and details abut the prducts, services, and supprt that HPE Sftware ffers. HPE Sftware nline supprt prvides custmer self-slve capabilities. It prvides a fast and efficient way t access interactive technical supprt tls needed t manage yur business. As a valued supprt custmer, yu can benefit by using the supprt website t: Search fr knwledge dcuments f interest Submit and track supprt cases and enhancement requests Dwnlad sftware patches Manage supprt cntracts Lk up HPE supprt cntacts Review infrmatin abut available services Enter int discussins with ther sftware custmers Research and register fr sftware training Mst f the supprt areas require that yu register as an HP Passprt user and t sign in. Many als require a supprt cntract. T register fr an HP Passprt ID, click Register n the HPE Supprt site r click Create an Accunt n the HP Passprt lgin page. T find mre infrmatin abut access levels, g t: HPSW Integratins Catalg accesses the new HPSW Integratins and Slutins Catalg website. This site enables yu t explre HPE Prduct Slutins t meet yur business needs, includes a full list f Integratins between HPE Prducts, as well as a listing f ITIL Prcesses. The URL fr this website is HPE Universal CMDB (10.31) Page 2 f 300

3 Cntents Intrductin 11 Chapter 1: Cnfiguratin Management Database (CMDB) 12 CMDB Overview 12 IPv6 Supprt fr UCMDB/Universal Discvery 13 Cnfiguratin Items (CIs) 14 Query Ndes and Relatinships 15 Histry Strage and Purging in UCMDB 15 Unified Resurce Manager (URM) 17 Chapter 2: Lgging In t UCMDB 18 Hw t Lg In t UCMDB 18 Hw t Enable Lgging In t UCMDB Autmatically 20 Hw t Lg In t UCMDB Lcal Installatin Mde 21 Hw t Launch UCMDB UI frm Chrme 43+, Firefx 48+, Micrsft Edge, r Safari Hw t Custmize the UCMDB Applet Files Directry 26 Hw t Change the Default Time Limit fr User Inactivity Lg Out 26 Trubleshting Lgging In t UCMDB 27 Chapter 3: Navigating HPE Universal CMDB 30 Navigating the HPE Universal CMDB User Interface 30 Menus and Optins 33 Status Bar 35 Anntatin Tl 36 Chapter 4: UCMDB Brwser 41 UCMDB Brwser Overview 41 Initial Setup fr Wrking with the UCMDB Brwser 42 Hw t Grant Access t the UCMDB Brwser 43 Hw t Authrize Access t CIs 44 Use Cases 45 Hw t Change the UCMDB Integratin User Credentials 46 Hw t Cnfigure the UCMDB-UI Server URL 47 Hw t Cnfigure LW-SSO 47 Hw t Cnfigure SSL 48 Hw t Cnfigure Multiple UCMDB Servers 49 HPE Universal CMDB (10.31) Page 3 f 300

4 Hw t Specify Data Stres Used fr Data Lading 51 Hw t Change the Default Prt f the Tmcat Server 52 Hw t Deply the UCMDB Brwser with a Different Rt Cntext 53 Hw t Upgrade the UCMDB Brwser 53 Hw t Cnfigure an Envirnment t Use Multiple Reverse Prxies 55 Hw t Cnfigure the Enhanced Search Engine 56 Hw t Brand the UCMDB Brwser 71 Hw t Set UCMDB Brwser Sessin t Expire 72 Administratin 74 Chapter 5: UCMDB Server Administratin 75 Basic Administratin Tasks 76 Hw t Enable HTTP Cmmunicatin fr UCMDB Server 77 Hw t Access the JMX Cnsle 78 Hw t Enable Remte Access t the JMX Cnsle 81 Hw t Manage UCMDB Licenses Using the JMX Cnsle 82 Hw t Access Supprt Using the JMX Cnsle 82 Hw t Cnfigure High Availability 87 Hw t Set Master Key fr Passwrd Encryptin n Data Flw Prbe 88 Hw t Set Master Keys 89 Hw t Cnfigure the UCMDB Mail Server 93 Hw t Change the Rt Cntext fr UCMDB Cmpnents 95 Hw t Custmize the Applicatin Title 96 Hw t Use the Database Tl 96 Hw t Deply Htfixes and Track Htfixes Applied n UCMDB Server 98 Hw t Cnfigure UCMDB Lg Levels 102 Hw t Retrieve UCMDB Server Lg Files 102 Hw t Cnfigure UCMDB t Save User Audit Lg t a Remte Machine 103 Hw t Cnfigure Micrsft IIS as Reverse Prxy fr UCMDB Server 105 Hw t Dwnlad a Zip File f Lg Files and Thread Dumps 105 Hw t Enable Validatin f the Hst Header f a Request 106 Hw t Retrieve UCMDB Server Lgs fr a Specific Time Frame 107 Hw t Use the User Activity Lg 108 Hw t Limit the Number f Cncurrent Sessins fr System Accunts 109 Hw t Set Up a Standalne Slr Envirnment 110 Hw t Run Slr in a Different Prcess than UCMDB 111 HPE Universal CMDB (10.31) Page 4 f 300

5 Change the Default Prt f the Slr 112 Mdify Slr Memry Size 112 Slr Aut Cmmit 113 Hw t Set UCMDB Server Time, Change Time Zne Setting, r Crrect System-induced Clck Drift 115 Hw t Disable Caching f Generated IDs fr CIs, Jbs, and URM Resurces 115 Hw t Increase the Java Heap Memry Used by the UCMDB UI Java Applet 116 Editing the JSP File 116 Editing the Cntrl Panel Java Settings 117 Hw t Cnfigure Cnfiguratin Manager t Cnnect t UCMDB Server 118 Hw t View the KPI Dashbard 119 Perfrmance Statistics Dashbard 120 Hw t Enable License Usage Tracking 125 Hw t Use the External JAR Cnfiguratin File 126 UCMDB Services 126 UCMDB Server Prts 130 UCMDB Integratin Service Prts 131 UCMDB Lg Files 132 General Lg Files 133 Class Mdel Lg Files 135 TQL Lg Files 136 Data-In Lg Files 137 Histry Lg Files 137 Enrichment Lg Files 140 Dal Lg Files 140 Authrizatin Lg Files 141 UCMDB UI Lg Files 142 Data Flw Management Lg Files 143 Lg Severity Levels 146 Lg Cnfiguratin Dialg Bx 147 Enhanced File Uplad Mechanism 148 Trubleshting and Limitatins UCMDB Server Administratin 148 Chapter 6: Infrastructure Settings Manager 150 Infrastructure Settings Manager Overview 150 HPE Universal CMDB (10.31) Page 5 f 300

6 Infrastructure Settings Validatin 150 Infrastructure Settings Manager User Interface 153 Change Default Value Dialg Bx 153 Infrastructure Settings Manager Page 154 Chapter 7: Package Manager 156 Package Administratin Overview 156 Package Zip File Cntents and Frmat 158 Packages fr Integratin Adapters 159 Cmpare and Merge Packages r Cntent Packs 159 Overview 159 Cmpare and Merge 160 Hw t Merge Packages r Cntent Packs 162 Lg and Backup Files 162 Hw t Create a Custm Package 163 Hw t Deply a Package 164 Hw t Exprt a Package 165 Hw t Install a Discvery and Integratin Cntent Pack 166 Hw t Use the JMX Cnsle t Perfrm Package Manager Tasks 167 Package Resurces 170 Resurce Types 173 Package Manager User Interface 176 Chse Resurces t Exprt Dialg Bx 176 Create Custm Package/Edit Package Wizard 177 Package Prperties Page 177 Resurce Selectin Page 178 Selectin Summary Page 180 Exprt Package Dialg Bx 180 Filter Dialg Bx 181 Find Dialg Bx 182 Package Manager Page 183 Undeply Package Resurce Wizard 187 Remve Resurces Page 187 Selectin Summary Page 188 Trubleshting and Limitatins Package Manager 188 Chapter 8: State Manager 190 State Manager Overview 190 HPE Universal CMDB (10.31) Page 6 f 300

7 Hw t Define a State 190 State Manager User Interface 191 State Manager Page 191 Chapter 9: Scheduler 193 Hw t Define Tasks That Are Activated n a Peridic Basis 193 Hw t Rebuild Indexes n Micrsft SQL Databases 195 Scheduler User Interface 196 Actin Definitin Dialg Bx 196 Filter Dialg Bx 197 Jb Definitin Dialg Bx 198 Jb Scheduler Page 202 Select Days Dialg Bx 203 Select Hurs Dialg Bx 204 Chapter 10: Recipients Manager 205 Recipients Manager Overview 205 Hw t Define an Recipient 205 Cnfigurable Rate Settings 205 Recipients Manager User Interface 206 Add Mail Recipient Dialg Bx 206 Recipients Manager Page 207 Chapter 11: CI Lifecycle and the Aging Mechanism 209 The Aging Mechanism Overview 209 CI Lifecycle Overview 210 Hw t Enable and Run the Aging Mechanism 210 Hw t Generate CI Lifecycle Data and Filter the Results 212 CI Lifecycle User Interface 213 Aging Run Statistics Dialg Bx 213 Aging Status Tab 214 CI Lifecycle and Relatinship Tabs 215 CI Lifecycle Page 218 Filter Dialg Bx 218 Aging Parameters 219 Cnfiguring Security 220 Chapter 12: User Permissins fr UCMDB 221 User Permissins in a Single Tenant Envirnment 221 User Permissins Wrkflw 222 HPE Universal CMDB (10.31) Page 7 f 300

8 User Permissins fr the UCMDB Brwser 223 Multi-Tenancy Overview 226 User Permissins in a Multi-Tenancy Envirnment 229 Tenant Assciatin Rules 233 Cnfiguratin Manager in a Multi-Tenant UCMDB Envirnment 235 Multi-Tenancy Wrkflw 236 Hw t Change the Tenant Assignment fr a Resurce r a CI 237 User Permissins User Interface 238 Assign Tenants Dialg Bx 238 Assign Resurces t Rles and Resurce Grups Dialg Bx 241 Chapter 13: Users and Grups 244 Users and Grups Overview 244 Users and Grups Wrkflw 245 Default Passwrd Plicy 246 Users and Grups User Interface 246 New Grup Wizard 247 Grup Details Page 247 Grup Assciatin Page 248 Rles Assciatin Page 248 Default Tenant Page 249 New User Wizard 249 User Name and Passwrd Page 250 User Details Page 251 Grup Assciatin Page 252 Rle Assciatin Page 252 Default Tenant Page 253 Select Tenants fr Rle Dialg Bx 253 Users and Grups Page 254 Chapter 14: Rles Manager 259 Rles Manager Overview 259 Hw t Create a New Rle and Define Permissins fr the Rle 260 Rles Manager User Interface 262 New Rle Dialg Bx 262 Rles Manager Page 262 Resurces Tab 264 Brwser CI Access Cntrl Tab 266 HPE Universal CMDB (10.31) Page 8 f 300

9 Resurce Grups Tab 267 General Actins Tab 267 Rle Details Tab 268 Permissins Overview Tab 268 Permissins Summary 268 Chapter 15: Resurce Grups 275 Resurce Grups Overview 275 Hw t Define a Resurce Grup 275 Resurce Grups User Interface 276 New Resurce Grup Dialg Bx 276 Resurce Grups Page 277 Chapter 16: Ownership Management 279 Ownership Management Overview 279 Ownership Management User Interface 279 Ownership Management Page 279 Chapter 17: LDAP Mapping 281 LDAP Mapping Overview 281 Synchrnize Universal CMDB User Grups with LDAP Grups 282 Hw t Cnfigure LDAP fr Active Directry 283 Search LDAP Users 285 LDAP Mapping User Interface 287 LDAP Grups t UCMDB Grups Mappings Dialg Bx 287 LDAP Mapping Page 287 Remte Grup Users Dialg Bx 289 Chapter 18: Tenants Management 290 Tenants Management Overview 290 Multi-Tenancy Architecture vs. Multi-Custmer Architecture 290 Multi-Custmer (MC) Architecture 291 Multi-Tenant (MT) Architecture 292 Multi-Tenant Architecture with Tenant-Aware Recnciliatin 294 Migratin frm Single-Tenant Architecture t Multi-Tenant r Multi- Custmer Architecture 295 Prbe Cnnectin Address in MT and MC Architectures 295 Mdeling in a Multi-Tenant Envirnment 296 Hw Scheduler Runs in a Multi-Tenant Envirnment 296 Tenants Management User Interface 297 HPE Universal CMDB (10.31) Page 9 f 300

10 New Tenant/Edit Tenant Dialg Bx 297 Tenants Management Page 297 Shrtcut Menu 298 Send dcumentatin feedback 300 HPE Universal CMDB (10.31) Page 10 f 300

11 Intrductin HPE Universal CMDB (10.31) Page 11 f 300

12 Chapter 1: Cnfiguratin Management Database (CMDB) This chapter includes: CMDB Overview 12 IPv6 Supprt fr UCMDB/Universal Discvery 13 Cnfiguratin Items (CIs) 14 Query Ndes and Relatinships 15 Histry Strage and Purging in UCMDB 15 Unified Resurce Manager (URM) 17 CMDB Overview The CMDB is the central repsitry fr the cnfiguratin infrmatin that is gathered frm the Data Flw Management (DFM) prcess and the varius third-party applicatins and tls. The CMDB cntains all the cnfiguratin items (CIs) and relatinships created in Universal CMDB, whether created autmatically frm the DFM prcess r inserted manually. The CIs and relatinships tgether represent a mdel f all the cmpnents f the IT Universe in which yur business functins. The CMDB stres and handles the infrastructure data cllected and updated by the DFM prcess. Fr mre infrmatin abut the DFM prcess, see the HPE Universal CMDB Discvery and Integratins Cntent Guide. The IT Universe mdel can be very large, cntaining millins f CIs. T facilitate their management, yu wrk with the CIs in a view that prvides a subset f the verall cmpnents in the IT Universe wrld. Yu use factry views r views defined in the Mdeling Studi t display and manage the CIs and relatinships in the CMDB. The views enable yu t fcus n specific IT areas and are available via the CI Selectr. An example f a view is shwn in the fllwing figure: HPE Universal CMDB (10.31) Page 12 f 300

13 Chapter 1: Cnfiguratin Management Database (CMDB) The CMDB als cntains the TQL query definitins that are used t query and retrieve data frm the CMDB fr presentatin in the view, and the cnfiguratin item type (CIT) mdel, a repsitry fr the CI types used t define the CIs and relatinships. Fr infrmatin n TQL queries, see Tplgy Query Language in the HPE Universal CMDB Mdeling Guide. IPv6 Supprt fr UCMDB/Universal Discvery Unless therwise specified, UCMDB and Universal Discvery supprt the IPv6 prtcl as fllws: UCMDB Web UI (including Jetty Web Server and Java Applets) wrks ver IPv6. The JMX interface as well as pure Web UI (such as the lgin screen) supprt IPv6. Data Flw Prbe t UCMDB server cmmunicatins can be dne via IPv6. Prbe clustering supprts IPv6 cmmunicatin. UCMDB Server can cnnect t the MS SQL/Oracle/PstgreSQL databases ver IPv6. High-availability clusters (at the JGrups level) can cmmunicate wrk ver IPv6. The UCMDB Brwser supprts IPv6. IP ranges fr Data Flw Prbes and Management Znes can be defined in the UCMDB user interface in IPv6 frmat. Fr details, see New/Edit Range Dialg Bx in the HPE Universal CMDB Data Flw Management Guide. Sme f the discveries and integratins prvided ut-f-the-bx with the UCMDB wrk ver IPv6. Amng thse supprted are: Basic netwrk discvery: Ping sweeps can be dne ver IPv6 ranges The IP/MAC Address Harvesting jb was extended t read IPv6 specific ARP cache tables. HPE Universal CMDB (10.31) Page 13 f 300

14 Chapter 1: Cnfiguratin Management Database (CMDB) Inventry Discvery and its varius cmpnents are IPv6 enabled: Inventry Scanners (ff-site scan file saving) Scanner Scheduler (dwnlad f scanners and cnfiguratin) Stre and Frward Server UD Agent (Cmmunicatin and Call Hme) Inventry Discvery by Scanners jb Inventry Discvery by Manual Scanner Deplyment Nte: Fr a cmplete list f discvery jbs and integratins that supprt IPv6, see "Universal Discvery IPv6 Supprt" in the HPE UCMDB Discvery and Integratins Cntent Guide - Supprted Cntent. The UCMDB SDK API wrks ver IPv6. The SDK can be accessed via IPv6. APIs that take IP addresses can accept IPv6 addresses (e.g. fr Discvery ranges). Web services wrk ver IPv6. Cnfiguratin Items (CIs) A cnfiguratin item (CI) is a cmpnent f the CMDB that represents a physical r lgical entity in the system, fr example, hardware, sftware, services, business prcesses, and custmers. The CIs are part f the IT Universe mdel in the CMDB, where they are rganized int a hierarchical frmat based n the interdependencies in yur rganizatin's IT envirnment. The interdependencies in Universal CMDB are called relatinships. Each CI belngs t a cnfiguratin item type (CIT). The CIT defines a categry f CIs used in Universal CMDB. The CITs prvide templates fr creating the CIs and assciated prperties in each categry. Yu view and manage the CIs in the CMDB using views. Each view shines a sptlight n part f the IT Universe mdel. Fr further details n wrking with CIs in Universal CMDB, see "Wrking with CIs" in the HPE Universal CMDB Mdeling Guide. HPE Universal CMDB (10.31) Page 14 f 300

15 Chapter 1: Cnfiguratin Management Database (CMDB) Query Ndes and Relatinships Query ndes are the cmpnents frm which TQL queries are built in Enrichment Manager, Impact Analysis Manager, and the Mdeling Studi. Fr details, see "Creating TQL Queries in the UCMDB Managers" in the HPE Universal CMDB Mdeling Guide. Nte: When wrking in views, query ndes are called view ndes in the Universal CMDB user interface. Relatinships are cnnectins defined between CIs. Relatinships are defined ne at a time fr each pair f query ndes in a TQL query. Fr details n wrking with relatinships, see "Wrking with Relatinships" in the HPE Universal CMDB Mdeling Guide. Histry Strage and Purging in UCMDB Histry Strage Universal CMDB stres histry fr all CIs and relatinships. By default, histry is stred fr all attributes f a CI r relatinship. Yu can cnfigure specific CIT attributes t be excluded frm histry strage by selecting the Nt Tracked fr Histry qualifier fr thse attributes. Fr details n editing CIT attributes, see "Add/Edit Attribute Dialg Bx" in the HPE Universal CMDB Mdeling Guide. Baseline Prcess Stred histry events fr CIs and relatinships are gruped by CI type. Fr each CI type, the histry events fr each CI instance are stred by mnthly perids with a separate database table fr each mnthly perid. At the beginning f each table, the current data fr all CIs and relatinships is recrded. Such histry entries are knwn as a baselines. The Baseline Prcess is the mechanism that creates a new table and recrds the baseline entries in the histry. The Baseline Prcess runs at the date and time fixed as the start time f a perid. This value is defined using the histry.baseline.defined.start.date setting in the verride.prperties file lcated in the hp\ucmdb\ucmdbserver\cnf flder. The setting stres the day f the mnth in the first 2 digits and the hur in the last 2 digits (with a space between the day and the hur). The setting applies t all CI types, and the Baseline Prcess runs at the specified hur n the specified day in each mnth. The default value fr the setting is 10 00, which means that by default, the Baseline Prcess runs at midnight n the 10th f each mnth. HPE Universal CMDB (10.31) Page 15 f 300

16 Chapter 1: Cnfiguratin Management Database (CMDB) If the server was dwn at the start time f the perid, the Baseline Prcess runs at the predefined baseline hur n the next day that the server is running, and creates all the required tables. If the Baseline Prcess failed t run at the start f a new perid, and a new table was nt yet created, then all histry events after the start f the new perid are temprarily stred in the previus perid s table. The events are mved t the apprpriate mnthly table the next time the Baseline Prcess runs and creates a table fr the new perid. Nte: Values between 01 and 28 are valid fr the day f the mnth setting; values between 00 and 23 are valid fr the hur setting. The starting hur f the Baseline Prcess shuld nt be the same as the starting hurs f the Histry Purging r Aging prcesses. Because the Baseline Prcess affects the ppulatin integratin perfrmance, schedule the Baseline Prcess t run at an apprpriate distance frm the discvery prcess time. Enabling/disabling server setting autmatically adjust clck fr daylight saving time may result in crrupting the histry partitins. It is recmmended t chse the setting value fr this at the installatin time and then d nt change it back. Histry Purging Universal CMDB purges the stred histry data peridically. The default setting schedules purging nce every 24 hurs at night. Yu can cnfigure the purging schedule using the fllwing histry infrastructure settings: Histry Scheduler Hur Of The First Run. The scheduled time f the first purge. Histry Scheduler Interval. The number f hurs between purges. When purging runs, it permanently deletes all histry data prir t a certain time, except fr the CIs and relatinships that were remved frm the CMDB. The remved CI and relatinship data is stred in a different table fr an additinal specified perid f time. Yu can cnfigure the number f mnths f histrical data t stre using the fllwing histry infrastructure settings: Histry Mnths T Save Back. The number f mnths f histrical data t save. Any data lder than this is purged. The default value is 3 mnths. Nte: During the upgrade t versin r later, all snapshts lder than the perid defined fr saving histry are deleted. All custm reprts based n such snapshts will be empty. HPE Universal CMDB (10.31) Page 16 f 300

17 Chapter 1: Cnfiguratin Management Database (CMDB) Histry purging extra mnths t save back remved data. The number f extra mnths t stre the remved CI and relatinship data after it is purged. If this value is set t 0, the data is nt saved fr an additinal perid. Nte: Purging cannt be disabled. It begins running accrding t the set schedule immediately after server startup. Unified Resurce Manager (URM) The Unified Resurce Manager (URM) is an XML-based repsitry fr CMDB resurces. A resurce is defined as all CMDB data ther than CIs. Examples f resurces include TQL queries, views, users, and the class mdel, as well as discvery resurces such as discvery scripts, integratin and discvery adapters, discvery jbs, and s n. The URM can be accessed using the JMX cnsle nly. Frm the JMX cnsle page, click UCMDB:service=URM Services t pen the JMX page with the relevant methds. Fr mre infrmatin, see Hw t View Discvery Resurce Histry in the HPE Universal CMDB Data Flw Management Guide. Cautin: Never change a resurce frm the URM. Users are stred using the URM type Auth_USER. A user's passwrd is stred in hashed frmat in the passwrd attribute f the XML file representing that user in the URM. HPE Universal CMDB (10.31) Page 17 f 300

18 Chapter 2: Lgging In t UCMDB This chapter includes: Hw t Lg In t UCMDB 18 Hw t Enable Lgging In t UCMDB Autmatically 20 Hw t Lg In t UCMDB Lcal Installatin Mde 21 Hw t Launch UCMDB UI frm Chrme 43+, Firefx 48+, Micrsft Edge, r Safari Hw t Custmize the UCMDB Applet Files Directry 26 Hw t Change the Default Time Limit fr User Inactivity Lg Out 26 Trubleshting Lgging In t UCMDB 27 Hw t Lg In t UCMDB 1. In the Web brwser, enter the URL f the HPE Universal CMDB Server, fr example: name r IP address>.<dmain name>:8443 where <server name r IP address>.<dmain name> represents the fully qualified dmain name (FQDN) f the HPE Universal CMDB Server. Nte: The FQDN r URL used t access UCMDB cmpnents shuld nt cntain UCMDB reserved names like the nes described in the High Availability sectin f the interactive HPE Universal CMDB Deplyment Guide. Fr example, mam-cllectrs, ucmdb-ui, ucmdb-brwser, and jmx-cnsle. Starting frm versin 10.30, by default the HTTPS prtcl is enabled fr UCMDB server, with the HTTP prtcl being disabled and UCMDB server n lnger accessible with the HTTP prtcl. Hwever, if necessary, yu can still enable HTTP cmmunicatin fr UCMDB server. Fr instructins, see "Hw t Enable HTTP Cmmunicatin fr UCMDB Server" n page 77. HPE Universal CMDB (10.31) Page 18 f 300

19 Chapter 2: Lgging In t UCMDB T access the UCMDB UI applicatin frm Chrme 43+, Firefx 48+, r ther web brwsers withut supprt fr NPAPI plugins, see "Hw t Launch UCMDB UI frm Chrme 43+, Firefx 48+, Micrsft Edge, r Safari 10+" n page 22. If HPE Universal CMDB is set up t wrk thrugh a reverse prxy, enter name>:443 where prxy_server_name is the name r IP address f the prxy server. If the crrect Java versin is nt installed n yur machine, yu can chse t dwnlad the versin frm sun.cm r frm the UCMDB server. (If yu lg in withut installing Java, yu will nt be able t view pages that need a Java applet t display crrectly.) The UCMDB splash screen displays the fllwing ptins: UCMDB. Opens the lgin page. After lgging in, the mdule yu had pen at the end f yur last sessin pens. If yur user preferences are deleted, the IT Universe Manager is pened by default. User Management. Opens the lgin page. After lgging in, yu are taken directly t the Users and Grups mdule where yu can manage yur UCMDB users. UCMDB Cnfiguratin Manager. Opens the Cnfiguratin Manager applicatin. Fr the link t be active, Cnfiguratin Manager must be running and the infrastructure setting Cnfiguratin Manager URL must cntain the applicatin s URL. UCMDB Brwser. Opens the UCMDB Brwser. The UCMDB Brwser is a web-based tl fr displaying UCMDB infrmatin quickly and easily. Fr the link t be active, UCMDB Brwser must be running and the infrastructure setting UCMDB Brwser URL must cntain the applicatin s URL. Nte: A user wh has nt been granted access t the UCMDB Brwser UI (by setting the infrastructure setting Access t UCMDB Brwser) will nt be able t lg in. UCMDB Class Mdel. Opens the UCMDB Class Mdel Reference, which cntains infrmatin n all packages, CI types, and relatinships in the class mdel. Server Status. Opens the Server Status page. JMX Cnsle. Enables yu t perfrm peratins n the CMDB thrugh the JMX cnsle interface. API Cnnectin Test. Displays infrmatin abut the HPE Universal CMDB Server fr yu t use when running an API t the CMDB. HPE Universal CMDB (10.31) Page 19 f 300

20 Chapter 2: Lgging In t UCMDB API Client Dwnlad. Dwnlads the UCMDB API jar file. API Reference. Opens the HPE UCMDB API Reference dcumentatin. Nte: Yu must have a valid license t access UCMDB, UCMDB Cnfiguratin Manager, and UCMDB Brwser. If yur license has expired, yu will be unable t lg in t any applicatin. If the number f days remaining until yur license will expire is lwer than the Expiring license ntificatin perid setting in the Infrastructure Settings Manager (the default is 30 days), a warning message is displayed. 2. Click UCMDB r User Management. Tip: T g straight t the lgin page, enter: name r IP address>.<dmain name>:8443/ucmdb-ui 3. Enter yur lgin parameters. 4. If HPE Universal CMDB is installed in a multiple custmer r multiple state envirnment (fr example, HPE Sftware-as-a-Service r HPE Universal CMDB Cnfiguratin Manager), a Custmer field is displayed. Chse the Custmer name frm the list. 5. (Optinal) Remember me n this machine. Select fr autmatic lgin s that the next time yu lg in t UCMDB, yu d nt need t enter yur user name and passwrd. Nte: If yu lg in t UCMDB with this ptin selected, when yu lg ut by clicking the Lgut buttn, nly yur user name is remembered. Fr mre infrmatin abut autmatic lgin, see "Hw t Enable Lgging In t UCMDB Autmatically" belw. 6. Click Lgin. After lgging in, yur user name appears at the tp right f the screen. Nte: HPE Universal CMDB Cnfiguratin Manager Users: The Data Flw Management mdules are available nly when yu are lgged in t UCMDB in Actual state. Hw t Enable Lgging In t UCMDB Autmatically Advanced lgin ptins enables yu t autmate lgin, limit lgin access, and prvide direct lgin capabilities t specific pages in HPE Universal CMDB. When autmatic lgin is enabled frm the lgin page, and when yu clse the brwser tab withut using the Lgut buttn at the tp f the Universal CMDB page, the next time yu enter this URL t access HPE Universal CMDB ( name r IP address>.<dmain name>:8443/ucmdb-ui) r access the URL f the HPE Universal CMDB Server ( name r IP HPE Universal CMDB (10.31) Page 20 f 300

21 Chapter 2: Lgging In t UCMDB address>.<dmain name>:8443) t get t the splash screen and then click UCMDB, the lgin page des nt pen, the lgin name and passwrd d nt have t be entered, and the default page that is set t pen pens autmatically. Cautin: This ptin culd be cnsidered a security risk and shuld be used with cautin. T enable autmatic lgin: 1. In the HPE Universal CMDB lgin page, select the ptin Remember me n this machine. 2. When cmpleting yur sessin, d nt click Lgut at the tp f the page, but clse the brwser tab. When yu pen a new brwser tab and navigate t link name r IP address>.<dmain name>:8443 and then click UCMDB, the lgin page shuld be skipped. Guidelines fr Using Autmatic Lgin Using the Lgut ptin at the tp f the HPE Universal CMDB page, the Remember me n this machine ptin is still enabled with yur user name remembered. If yu lg ut using the Lgut buttn, the next time yu try t lg in, the Lgin page pens with yur lgin name pre-filled, yu nly need t enter yur passwrd manually. The Remember me n this machine ptin can nly be manually canceled by the user when he/she lgs in next time. Hw t Lg In t UCMDB Lcal Installatin Mde Lcal installatin mde is a methd f lading UCMDB which reduces the applet lading time significantly. When using lcal installatin mde, the applet files (.JAR files) are laded t a lcal flder called UcmdbAppletJars. The classes are laded using a custmized class lader which wrks faster, but des nt verify the signature f the signed jars. Lcal installatin mde is thus cnsidered an unsecured mde. Nte: By default, the UcmdbAppletJars flder is under the envirnment s temprary directry. Yu can specify a different directry fr the UcmdbAppletJars flder in the Infrastructure Settings Manager. Fr details, see "Hw t Custmize the UCMDB Applet Files Directry" n page 26. T select lcal installatin mde: 1. Prerequisite: In the Infrastructure Settings Manager, ensure that the Lcal installatin mde permissin setting is set t True. HPE Universal CMDB (10.31) Page 21 f 300

22 Chapter 2: Lgging In t UCMDB 2. When lgging in, select the Enable lcal installatin mde check bx n the lgin screen. Nte: Yu can set the default status f the check bx using the Lcal installatin mde initial status setting. When the setting is set t True, the check bx is selected by default. When it is set t False, the check bx is cleared by default. If yu select the Remember me n this machine check bx at lgin, the status f the Enable lcal installatin mde check bx remains the same fr the next lgin, regardless f the infrastructure setting. Fr HPE Sftware-as-a-Service custmers, the installatin settings are n a per-custmer basis. Hw t Launch UCMDB UI frm Chrme 43+, Firefx 48+, Micrsft Edge, r Safari 10+ Starting frm versin 10.30, with the intrductin f the JNLP feature and a new JMX setting mam.web.is.jnlp.enabled, it is pssible t launch UCMDB UI applicatin frm web brwsers withut supprt fr NPAPI plugins, including Chrme 43+, Firefx 48+, Micrsft Edge, and Safari 10+. The JNLP feature allws users wh use web brwsers withut supprt fr NPAPI plugins t launch the UCMDB UI applicatin. Instead f running it in the internet web thrugh the Java plug-in, a JNLP file is saved n the client machine. After launching the JNLP file, it runs in a separate Java prcess and lads the UCMDB UI as a desktp applicatin. The fllwing web brwsers are supprted fr accessing UCMDB UI using JNLP: Chrme versin 43 r later Firefx versin 48 r later Micrsft Edge Safari versin 10 r later The fllwing scenaris are nt supprted: Lgin thrugh LW-SSO CAC lgin FIPS mde LDAP is cnfigured HPE Universal CMDB (10.31) Page 22 f 300

23 Chapter 2: Lgging In t UCMDB Hw t launch UCMDB UI frm web brwsers withut supprt fr NPAPI plugins Nte: Mst f the cnfiguratins here are ne-time peratin nly. T d s, perfrm the fllwing: 1. Prerequisites Oracle JRE is installed n the client machine (the latest versin recmmended) Make sure yu have enabled JNLP frm JMX cnsle Otherwise fllw the instructins belw t enable JNLP: i. Access the UCMDB server JMX cnsle: Launch a Web brwser and enter the fllwing address: machine name r IP address>:8443/jmx-cnsle. Yu may have t lg in with a user name and passwrd. (default username: sysadmin) ii. iii. Lcate the UCMDB:service=Settings Services > setglbalsettingvalue peratin. T enable JNLP, prvide values fr the fllwing parameters fr the setglbalsettingvalue methd: name: mam.web.is.jnlp.enabled value: true The default value f the mam.web.is.jnlp.enabled setting is false. iv. Click Invke. The setting takes effect immediately. 2. Imprt the certificate t yur client Nte: This is needed nly when yu d nt have a certificate prvided by a Certificate Authrity. a. Exprt a certificate (fr example, ucmdb.cer) and save it t yur machine. Taking Windws and Chrme as an example, i. In the client web brwser, enter machine name r IP address>:8443/. ii. Click the lck icn in the address bar. iii. Click the Details link right under the site address. The Details pane pens t the Overview tab page in the right side iv. Click View Certificate. HPE Universal CMDB (10.31) Page 23 f 300

24 Chapter 2: Lgging In t UCMDB v. In the Certificate dialg bx, g t the Details tab, find the certificate which CN = HP Universal CMDB, and click Cpy t File. The Certificate Exprt Wizard pens. vi. vii. viii. ix. Click Next. On the Exprt File Frmat page, select DER encded binary X.509 (.CER). and click Next. On the File t Exprt page, enter a file name (fr example, ucmdb) and click Next. Click Finish. b. Imprt the certificate by executing the fllwing cmmand: keytl -imprtcert -alias ucmdb -file <filepath>\ucmdb.cer -keystre <JRE_HOME>\lib\security\cacerts Fr example, keytl -imprtcert -alias ucmdb -file C:\Users\Administratr\Desktp\ucmdb.cer -keystre C:\Prgram Files (x86)\java\jre1.8.0_101\lib\security\cacerts c. Yu may need t enter the default passwrd changeit, and enter yes when prmpted "Trust this certificate?". d. (Optinal) Restart the UCMDB Server. 3. Launch UCMDB UI as a desktp applicatin a. In the Web brwser, enter the URL f the HPE Universal CMDB Server, fr example: name r IP address>.<dmain name>:8443 where <server name r IP address>.<dmain name> represents the fully qualified dmain name (FQDN) f the HPE Universal CMDB Server. Fr details abut the ptins available n the UCMDB splash screen, see "Hw t Lg In t UCMDB" n page 18. Tip: In case yu see a message like "Yur cnnectin is nt secure", g t the Advanced settings and add a security exceptin. Fr example, n Firefx, click Advanced > Add Exceptin, and then in the Add Security Exceptin dialg bx that pps up, click Cnfirm Security Exceptin. b. Click UCMDB r User Management. HPE Universal CMDB (10.31) Page 24 f 300

25 Chapter 2: Lgging In t UCMDB c. Click Run as Java Web Start app. On Chrme, a UCMDB.jnlp file is dwnladed t yur lcal machine autmatically. Duble-click the dwnladed UCMDB.jnlp file t launch it. On Firefx, the Opening UCMDB.jnlp dialg bx pps up. Select Open with Java(TM) Web Start Launcher (default) and click OK if yu want t launch UCMDB UI directly. Select Save File and click OK if yu wuld like t save the file and launch UCMDB UI later. Duble-click the dwnladed UCMDB.jnlp file t launch it. d. In the D yu want t run this applicatin? dialg bx, click Run. The UCMDB.jnlp file runs in a separate Java prcess and lads the UCMDB UI as a desktp applicatin. e. In the HP Universal CMDB dialg bx that pps up, enter yur UCMDB server lgin parameters. f. Click Lgin. Universal CMDB launches as a desktp applicatin. T exit Universal CMDB, click the Clse applicatin windw. buttn at the tp right crner f the 4. (Optinal) Cnfigure the JNLP memry size If necessary, yu may want t increase the JNLP memry size. a. On the UCMDB server machine, pen the <UCMDB_Server_Hme>/deply/ucmdbui/jnlp-generate.jsp file using a text editr. b. Lcate the fllwing line: <j2se versin="1.5+" initial-heap-size="512m" max-heap-size="1024m"/> c. Mdify the value f the initial-heap-size r max-heap-size setting t meet yur needs, and save the file. d. Delete the UCMDB.jnlp file yu dwnladed in step 3.c, and re-dwnlad the UCMDB.jnlp file by refreshing the web page and clicking the Run as Java Web Start app buttn frm the web brwser. Nte: Fr mre details abut the JNLP cnfiguratin, see JNLP File Syntax. HPE Universal CMDB (10.31) Page 25 f 300

26 Chapter 2: Lgging In t UCMDB Tip: T access the same Universal CMDB server frm ne f the abve mentined web brwsers, simply launch the dwnladed UCMDB.jnlp file. Hw t Custmize the UCMDB Applet Files Directry The UCMDB applet files (.JAR files) are laded t a flder called UcmdbAppletJars, which is by default under the fllwing directry: C:\Users\<username>\AppData\Lcal\Temp\ Yu can specify a different lcatin fr the UcmdbAppletJars flder. T d this, fllw these steps: 1. Select Administratin > Infrastructure Settings Manager > General Settings. 2. Lcate the Jar files directry setting, and then specify the directry in the Value field. Nte: The directry must be a valid system directry, fr example, D:\UCMDB\Applet jars. This setting takes effect after yu refresh the brwser r in yur next lgin, and the UCMDB applet files are then laded t the <specified_directry>\ucmdbappletjars flder. Hw t Change the Default Time Limit fr User Inactivity Lg Out HPE Universal CMDB includes an autmatic lgut feature which lgs ut when the system is inactive fr a set time perid. The default perid is 1440 minutes (24 hurs). After that time, a message appears with a 30-secnd cuntdwn until lgut. This task describes hw t adjust the time limit UCMDB stays pen withut any user input befre autmatically lgging ut. T change the default lgut time: 1. Select Administratin > Infrastructure Settings > General Settings categry > Inactive allwed time setting. 2. In the Value clumn, enter a new time interval in minutes. All values fr inactive allwed time are lcated in the Prperties windw (right-click Inactive Allwed Time > Prperties r duble-click the Inactive Allwed Time setting). HPE Universal CMDB (10.31) Page 26 f 300

27 Chapter 2: Lgging In t UCMDB Trubleshting Lgging In t UCMDB Use the fllwing infrmatin t trublesht pssible causes f failure t lg in t UCMDB. This sectin includes the fllwing: "Pssible Causes fr Failure t Lg In t UCMDB" belw "Java Nt Installed n Client Machine" n page 29 Pssible Causes fr Failure t Lg In t UCMDB Use the fllwing infrmatin t trublesht pssible causes f failure t lg int Universal CMDB. Prblem/Pssible Causes Universal CMDB is nt started successfully. Indicatin: The startup.lg file des nt include the fllwing line: **** All cmpnents started **** Slutins Slutin 1: Verify that the Universal CMDB Server is up and running by accessing the Web cnsle name>:8443/webcnsle where <server name> is the name f the Universal CMDB Server t which yu are cnnecting. Slutin 2: Check the database cnnectin: T check that the database server is up and running: 1. Launch the Web brwser and navigate t: 2. Under UCMDB, click UCMDB:service=Dal Services t pen the JMX MBean View. 3. Invke the functin getdbcntext with a custmerid parameter value f Check that the peratin result shws n prblems. Slutin 3: Check that the database cnnectin parameters are crrect. Ensure that yu can lg int the database server using the credentials yu prvided during the cnfiguratin prcedure. Slutin 4: Use the lg file C:\hp\UCMDB\UCMDBServer\runtime\lg\cmdb.dal.lg t verify the database cnnectins. HPE Universal CMDB (10.31) Page 27 f 300

28 Chapter 2: Lgging In t UCMDB Prblem/Pssible Causes Slutins Slutin 5: T verify that the database cnnectin is valid, in the Windws cmmand interpreter (cmd.exe), type sqlplus cmdb/cmdb@skazal. The CMDB is crrupted (fr example, a user recrd may have been deleted accidentally frm the CMDB). The Universal CMDB lgin fails. This may be due t an incrrect lgin name/passwrd cmbinatin. Universal CMDB lgin fails due t unexpected errrs. Imprt a previusly backed up database file. Fr details, see the HPE Universal CMDB Database Guide. Imprtant: The Universal CMDB server must be dwn while imprting the database. Nte: When yu imprt a previusly backed up database file, yu lse all data previusly existing in the system. Slutin 1: Ensure that yu enter a crrect lgin user name/passwrd cmbinatin. Slutin 2: Restre the default Slutin 1: Select Start > Prgrams > HP UCMDB > HP Universal CMDB Server Status and ensure that the service is running. Slutin 2: Lk fr errrs in the fllwing lg files: C:\hp\UCMDB\UCMDBServer\runtime\lg\errr.lg C:\hp\UCMDB\UCMDBServer\runtime\lg\ui-server.lg If yu find errrs that are unfamiliar t yu, cntact HPE Sftware Supprt. Universal CMDB fails t start, even thugh the passwrd was successfully changed. Restre the default passwrds: 1. Cpy the Basic_Authrizatin.zip file frm the <UCMDB_ installatin_directry>/cntent/backup flder t the <UCMDB_installatin_directry>/cntent/basic_packages flder. Overwrite the existing file. 2. Lg int the the JMX Cnsle and lcate the UCMDB- UI:name=UCMDB Integratin service. 3. Run setcmdbsuperintegratinuser by using the credentials f UISysadmin. HPE Universal CMDB (10.31) Page 28 f 300

29 Chapter 2: Lgging In t UCMDB Prblem/Pssible Causes Slutins 4. Stp the UCMDB Server. 5. Create a new schema. 6. Restart the UCMDB Server. Java Nt Installed n Client Machine If Java is nt installed n yur machine r yu have a versin lder than Java 8, during lgin a message is displayed asking yu t install the crrect Java Runtime Envirnment versin. JRE is needed t view Universal CMDB applets. Click the relevant buttn t allw Universal CMDB t install Java frm either racle.cm r the Universal CMDB Server. HPE Universal CMDB (10.31) Page 29 f 300

30 Chapter 3: Navigating HPE Universal CMDB This chapter includes: Navigating the HPE Universal CMDB User Interface 30 Menus and Optins 33 Status Bar 35 Anntatin Tl 36 Navigating the HPE Universal CMDB User Interface Universal CMDB runs in a Web brwser. Yu mve arund Universal CMDB using the fllwing navigatin functins: Navigatin Bar. Enable quick navigatin between mdules. Click the categry in the lwer part f the bar and select the mdule frm the icns in the upper part f the bar. HPE Universal CMDB (10.31) Page 30 f 300

31 Chapter 3: Navigating HPE Universal CMDB HPE Universal CMDB (10.31) Page 31 f 300

32 Chapter 3: Navigating HPE Universal CMDB Orientatin Map. Fr each categry, yu can display a map with brief descriptins f each f the mdules included by selecting Managers > Orientatin Map. Status Bar. Prvides infrmatin n the CMDB applicatin and enables yu t cnfigure certain aspects f yur interface. Cllapse/Expand Arrws. Enable cllapsing and expanding f panes with a single click. Nte: The Web brwser Back functin is nt supprted in Universal CMDB. Using the Back functin des nt always revert the current cntext t the previus cntext. T navigate t a previus cntext, use the breadcrumb functin. Cancel Feature fr Extended Operatins If an peratin invlving a request t the server, such as searching fr CIs, is taking a lng time t cmplete, yu can click the Cancel buttn that appears while the peratin is executing. Canceling the peratin restres the user interface, enabling yu t cntinue wrking. The Cancel feature is available HPE Universal CMDB (10.31) Page 32 f 300

33 Chapter 3: Navigating HPE Universal CMDB fr the fllwing peratins: Previewing a query, view, r mdel in the Mdeling Studi Calculating the query result cunt in the Mdeling Studi Searching fr CIs in the CI Selectr Displaying related CIs in IT Universe Manager Displaying Element Instances in the Mdeling Studi and the CIT Manager Suggested Values in Dialg Bxes When wrking in a multi-tenancy envirnment, the suggested values are nly taken frm CIs that the user has permissin t view (at least ne tenant assciated with the View CIs permissin assignment fr the user is included amng the CI s wner tenant r cnsumer tenants). In sme dialg bx text fields in Universal CMDB, such as the New CI dialg bx and the Query Nde Prperties dialg bx, suggested attribute values fr entered data are autmatically prvided when yu begin t enter an attribute value. The suggested values match the text entered up t this pint and are taken frm existing values fr the same attribute fr the selected CIT r any f its children. The values are srted alphabetically and a number appears next t each suggested value indicating the number f ccurrences f that value. If the number f suggested values exceeds a set maximum limit, n suggestins are displayed. Yu can set the maximum by changing the Maximum CI Cunt fr Attribute Value Suggestins setting in the Infrastructure Settings Manager. Nte: This feature is nly relevant fr the fllwing attribute types: string, integer, lng, duble, and flat. Menus and Optins The fllwing categries are available in the lwer part f the Navigatin Bar: Categry Mdeling Data Flw Management Descriptin Click t pen the Mdeling menu, where yu build and manage a mdel f yur IT universe in the CMDB. Fr details, see "Mdeling" in the HPE Universal CMDB Mdeling Guide. Click t pen the Data Flw Management (DFM) menu, where yu set up and run the DFM prcess t ppulate the IT Universe mdel with cnfiguratin items (CIs), and where yu wrk with Integratin Studi. Fr details, see the HPE HPE Universal CMDB (10.31) Page 33 f 300

34 Chapter 3: Navigating HPE Universal CMDB Categry Descriptin Universal CMDB Data Flw Management Guide. Fr details n DFM cntent, see the HPE Universal CMDB Discvery and Integratins Cntent Guide. Administratin Security Click t pen the Administratin menu, where yu cnfigure infrastructure settings, recipients, and schedules and wrk with the Package Manager and CI Lifecycle. Click t pen the Security menu, where yu define and manage users, user grups, tenants, rles, and resurce grups. Help Menu Yu access the fllwing nline resurces frm the Universal CMDB Help menu: Help n this page. Opens the UCMDB Help t the tpic that describes the current page r cntext. UCMDB Help. Opens the UCMDB Help Center hme page. The hme page prvides quick links t the main help tpics. Yu may need t lg in with a user name and passwrd. (Default user name is UISysadmin) Trubleshting & Knwledge Base. Opens the HPE Sftware Supprt website directly t the HPE Sftware Self-Slve Knwledge Search landing page. The URL fr this website is HP Sftware Supprt. Opens the HPE Sftware Supprt website. This site enables yu t brwse the knwledge base and add yur wn articles, pst t and search user discussin frums, submit supprt requests, dwnlad patches and updated dcumentatin, and mre. The URL fr this website is HP Sftware Web Site. Opens the HPE Sftware website, which cntains infrmatin and resurces abut HPE Sftware prducts and services. The URL fr this website is What's New? Opens the What s New dcument, which describes the new features and enhancements f the versin. Discvery and Integratins Cntent Help. Describes the default, ut-f-the-bx cntent: what is being discvered, the credentials required in discvery, hw t trublesht the discvery results, and hw t wrk with integratin adapters. UCMDB Best Practices. Opens the CMS Best Practices Library that is available nline. The URL HPE Universal CMDB (10.31) Page 34 f 300

35 Chapter 3: Navigating HPE Universal CMDB fr this website is UCMDB Class Mdel. Opens the UCMDB Class Mdel Reference, which cntains infrmatin n all packages, CI types and relatinships in the class mdel. Abut HP Universal CMDB.Opens the Abut HP Universal CMDB dialg bx, which prvides versin, license, patch, cpyright, and third-party ntice infrmatin. Status Bar This feature prvides infrmatin n the CMDB applicatin and enables yu t cnfigure certain aspects f yur interface. T access Appears at the bttm f the screen n all pages in Universal CMDB. User interface elements are described belw (unlabeled elements are shwn in angle brackets): UI Element Mdule User <License status> Descriptin Indicates the manager currently selected. Click this item t display a page with descriptins fr all f the managers. Indicates the name f the current user and the lgin time. Click t edit the user prfile. Indicates the current status f the licenses. Click t display a windw shwing the license summary, available licenses, and selected license. Nte: Starting frm versin 10.21, if yu use trial versin f the prduct, in sme cases yu may read "Expiring in 22 days" instead f "Expiring in 21 days" when hvering yur muse ver this icn. This is designed t prvide users with 21 full days, regardless f the timezne where the license is generated/stred and where it is cnsumed. <Server status> Indicates the current status f the server. Click t display a balln with the server availability, time zne and time. Nte: If the hidden setting hide.backend.server.name is set t true, the Server status displays Server is available, rather than displaying the name f the server. This setting is set t false by default, and can nly be accessed via the JMX cnsle. G t Settings Services and invke the setglbalsettingvalue methd. HPE Universal CMDB (10.31) Page 35 f 300

36 Chapter 3: Navigating HPE Universal CMDB UI Element Descriptin Cnfigure User Preferences. Opens the User Preferences dialg bx, which enables yu t reset system preferences. Lg Level Cnfiguratin. Opens the Lg Cnfiguratin dialg bx, which enables yu t set the lg level fr a selected lg. Run Screen Capture Tl. Runs the Anntatin tl which enables yu t take a screen capture f the applicatin. The tl als enables yu t anntate the screen capture, and save r print it. Fr details, see "Anntatin Tl" belw. Frce refresh the user's authenticatin. Refreshes the authenticatin f the user lgged in. <Ttal heap size> Indicates the amunt f memry that the applicatin is using. Run the Garbage Cllectr. Enables yu t manually clean the memry (it runs autmatically n a peridic basis). Help n Status Bar. Opens the Universal CMDB Online Help fr the Status Bar. Anntatin Tl This tl enables yu t anntate a snapsht f the screen yu are viewing, t highlight imprtant areas. It is available acrss all cmpnents f the system. T access Click the Run Screen Capture Tl buttn in the Status bar r select Tls > Screen Capture... frm the main menu. Imprtant infrmatin The anntatin ptins are lcated n the left side f the anntatin windw. When saving the anntatin: The snapsht is saved in.png frmat. Yu cannt select the New Flder buttn when saving in the My Dcuments directry r any f its subdirectries. HPE Universal CMDB (10.31) Page 36 f 300

37 Chapter 3: Navigating HPE Universal CMDB Anntatin Optins The fllwing elements enable yu t anntate yur snapsht. User interface elements are described belw: UI Element (A Z) Descriptin Pan Tl. Click t navigate the snapsht. Select Tl. Click and drag t select a specific area f the snapsht. Shape Tl. Click and drag t add a shape t the snapsht. Clicking the shape tl buttn enables the fllwing shape buttns: Rectangle. Click and drag t mark an area f the snapsht with a rectangle. Filled Rectangle. Click and drag t mark an area f the snapsht with a filled rectangle. Oval. Click and drag t mark an area f the snapsht with an val. Filled Oval. Click and drag t mark an area f the snapsht with a filled val. Runded Rectangle. Click and drag t mark an area f the snapsht with a rund rectangle. Filled Runded Rectangle. Click and drag t mark an area f the snapsht with a filled rund rectangle. Custmizatin. After clicking this buttn, yu can custmize yur line appearance thrugh the fllwing parts f the interface: Line Type. Chse the type f line yu want t add. Optins include: Slid Line Jagged Line Line Width. Select the width f the line, in pixels, in the anntatin. Line Tl. Click and drag t enable the line tl, which marks the selected area f the snapsht with a line. Custmizatin. After clicking this buttn, yu can custmize yur line appearance HPE Universal CMDB (10.31) Page 37 f 300

38 Chapter 3: Navigating HPE Universal CMDB UI Element (A Z) Descriptin thrugh the fllwing parts f the interface: Line Style. Chse the style f line yu want t add. Optins include: Regular line Line with endpints Line with arrws Line Type. Chse the type f line yu want t add. Optins include: Slid Line Jagged Line Line Width. Select the width f the line, in pixels, in the anntatin. Text Tl. Click and drag t pen a bx where yu can add text t the snapsht. Example: Add the syntax: This is the prblematic item abve a line marking an area f the snapsht. Brder and Fill Clrs Select the relevant square t chse the clr f the brder and fill f yur anntatins. The available squares are: Upper Square. Click t chse the clr f lines, as generated by the line tl and displayed in unfilled shapes. Lwer Square. Click t chse the clr t fill shapes. Clicking either f the squares generates a dialg bx with the fllwing tabs where yu chse the clr: Swatches HSB RGB Opacity Slide the pacity bar t chse the darkness level f the selected shape line, text line, r shape clr in the anntatin. Nte: A higher pacity percentage means that the selectin appears darker. A HPE Universal CMDB (10.31) Page 38 f 300

39 Chapter 3: Navigating HPE Universal CMDB UI Element (A Z) Descriptin lwer pacity percentage means that the selectin appears lighter. This field is enabled when either the shape tl, line tl, r text tl buttn is selected. Menu Bar The fllwing elements enable yu t perfrm selected actins n yur snapsht. Imprtant infrmatin The menu bar cntains elements which enable yu t: Change the appearance f the snapsht. Custmize the appearance f text anntated nt yur snapsht. These elements are enabled nly when the Text Tl buttn is selected. User interface elements are described belw (unlabeled elements are shwn in angle brackets): UI Element (A Z) Descriptin Save. Saves the snapsht n yur lcal machine. Nte: The snapsht is saved in.png frmat. Yu cannt select the New Flder buttn when saving in the My Dcuments directry r any f its subdirectries. Select All. Selects all f the anntatins added t yur snapsht. Clear Selected. Clears all anntatins. Und. Rlls back the mst recent actin perfrmed n the snapsht. Red. Cancels the rll back f the mst recent actin perfrmed n the snapsht. Zm In. Brings the snapsht view clser. HPE Universal CMDB (10.31) Page 39 f 300

40 Chapter 3: Navigating HPE Universal CMDB UI Element (A Z) Descriptin Zm Out. Sets the snapsht view further away. Restre riginal size. Restres the snapsht t its riginal size. Print. Prints the snapsht. Bld. Blds the text. Nte: This field is enabled nly when selecting the Text Tl buttn. Italic. Italicizes the text. Nte: This field is enabled nly when selecting the Text Tl buttn. Underline. Underlines the text. Nte: This field is enabled nly when selecting the Text Tl buttn. Anti-aliasing. Adjusts the pixel reading f text r anntatin lines s that they appear smther. Nte: This field is nly enabled when selecting the Text Tl buttn. <Fnt Family> Select the fnt fr the text in the reprt. Nte: This field is nly enabled when selecting the Text Tl buttn. <Fnt Size> Select the size f the fnt in the reprt. Nte: This field is nly enabled when selecting the Text Tl buttn. HPE Universal CMDB (10.31) Page 40 f 300

41 Chapter 4: UCMDB Brwser This chapter includes: UCMDB Brwser Overview 41 Initial Setup fr Wrking with the UCMDB Brwser 42 Hw t Grant Access t the UCMDB Brwser 43 Hw t Authrize Access t CIs 44 Hw t Change the UCMDB Integratin User Credentials 46 Hw t Cnfigure the UCMDB-UI Server URL 47 Hw t Cnfigure LW-SSO 47 Hw t Cnfigure SSL 48 Hw t Cnfigure Multiple UCMDB Servers 49 Hw t Specify Data Stres Used fr Data Lading 51 Hw t Change the Default Prt f the Tmcat Server 52 Hw t Deply the UCMDB Brwser with a Different Rt Cntext 53 Hw t Upgrade the UCMDB Brwser 53 Hw t Cnfigure an Envirnment t Use Multiple Reverse Prxies 55 Hw t Cnfigure the Enhanced Search Engine 56 Hw t Brand the UCMDB Brwser 71 Hw t Set UCMDB Brwser Sessin t Expire 72 UCMDB Brwser Overview UCMDB Brwser is a lightweight web-based client t access UCMDB data. The UCMDB Brwser prvides a simple and intuitive search fr Cnfiguratin Items (CIs) in the UCMDB and displays imprtant data in the cntext f the selected CI. It is an ideal tl fr prviding quick access t specific CI infrmatin. HPE Universal CMDB (10.31) Page 41 f 300

42 Chapter 4: UCMDB Brwser Fr a CI that is fund as a result f a search query, relevant data is presented and gathered int infrmatin widgets (fr example, Prperties, Envirnment, and Impact Simulatin widgets). Data is presented by default in a Preview mde, with the ptin t view mre cmprehensive data in an Expanded mde. The Brwser has a lightweight UI that ensures simple access t UCMDB infrmatin. N user administratin is required (this is handled by the UCMDB UI), and n upgrades are needed when updating t a newer versin. The Brwser has backward cmpatibility and wrks with different versins f the UCMDB server by using nly the UCMDB SDK. T grant a user access t the UCMDB Brwser UI, in the Rles Manager, click the General Actins tab and add the Access t UCMDB Brwser permissin (in the System Access Actins grup) t the selected rle. Yu can access the Brwser frm UCMDB by right-clicking a CI and selecting Open UCMDB Brwser. T disable this ptin, g t the Infrastructure Settings Manager and set the value f the Enable Open UCMDB Brwser Optin setting t False. When the ptin is disabled, yu can still access the Brwser frm a web brwser. The UCMDB Brwser is HTML-based and runs n mst f the latest mainstream brwsers n Windws, OS X, and ios. Fr detailed infrmatin, refer t the HPE Universal CMDB Brwser Supprt Matrix. The UCMDB Brwser is targeted fr the fllwing custmers: Nn-UCMDB administratrs, such as business wners r subject matter experts. Mbile device users, such as tablet users, wishing t take advantage f mbility and the mre intuitive UI fund n thse devices. UCMDB administratrs, wh need quick CI access. Nte: If yu update yur versin f UCMDB Brwser frm the versins released n HPE Live Netwrk, refer t the updated dcumentatin prvided with the UCMDB Brwser installatin fr the latest infrmatin. Initial Setup fr Wrking with the UCMDB Brwser In rder t enable a user t use the UCMDB Brwser, yu must d the fllwing: Enable access t the UCMDB Brwser In the Rles Manager, assign UCMDB Brwser access permissin t the relevant rle. HPE Universal CMDB (10.31) Page 42 f 300

43 Chapter 4: UCMDB Brwser Fr details, see "Hw t Grant Access t the UCMDB Brwser" belw. Specify which widgets will be displayed fr a rle in the UCMDB Brwser a. G t Security > Rles Manager. b. Click the Resurces tab and select UCMDB Brwser Widgets. c. Select the widgets fr which yu want t grant View permissin in the UCMDB Brwser and click. d. When yu are finished, click Save. Nte: The list f available UCMDB Brwser widgets will be visible in UCMDB nly after launching the UCMDB Brwser fr the first time. Fr details, see "Rles Manager Page" n page 262. Authrize access t CIs In the Rles Manager, specify the specific access levels t CIs that yu want t assign t the rle. Fr details, see "Hw t Authrize Access t CIs" n the next page. Nte: Brwser CI Access Cntrl is nt supprted fr in multi-tenant installatins. T enable CIs t be viewed in multi-tenant installatins, select the View CIs actin n the General Actins tab in the Rles Manager. Hw t Grant Access t the UCMDB Brwser Fr a user t access the UCMDB Brwser, yu must assign access permissin t the relevant rle. 1. G t Security > Rles Manager. 2. Select the rle t which yu want t add the permissin. 3. Click the General Actins tab. 4. In the System Access Actins sectin, select Access t UCMDB Brwser in the Available Actins list and add it t the Selected Actins list. 5. Click Save. HPE Universal CMDB (10.31) Page 43 f 300

44 Chapter 4: UCMDB Brwser Hw t Authrize Access t CIs Brwser CI Access Cntrl enables yu t assign granular access t the CIs in views r CI types in UCMDB, accrding t a user's assigned rle. A rle that has glbal View r Edit permissin can see all CIs and relatinships in UCMDB. A rle that has View r Edit permissin fr a particular view can see nly the CIs and relatinships in that view. In additin, permissin can be granted t view r edit particular CI types. Nte: Yu must assign at least ne permissin fr a view r CIT in rder t see CIs in the UCMDB Brwser. Yu must have View permissin n a particular CI in rder t refcus n it, even if that CI is visible in a widget because f Brwser CI Access Cntrl settings. T authrize access t CIs: 1. G t Security > Rles Manager. 2. Select the rle t which yu want t assign access. 3. Click the Brwser CI Access Cntrl tab and add available actins as required. 4. Select an available view r CI type fr which yu want t assign permissins. 5. When yu are finished, click Save. Fr additinal details abut permissins, see "User Permissins fr the UCMDB Brwser" n page 223. Nte: If a CI des nt have Edit permissin assigned thrugh a view r CI type, the Edit buttn will nt be displayed in the Prperties widget and it will nt be pssible t change any prperty's attributes in the UCMDB Brwser. A user will be able t see the cmpsite CIs f permitted CIs, even he has nt been granted specific permissin fr thse cmpsite CIs. If a user has permissins n CIs f tw CI types and thse CIs are nt cmpsite CIs, in rder t have permissin n their relatinship, the necessary triplet shuld be added t the calculated link. This is named Authrized Relatinship Additin (UCMDB Brwser), and it can be fund in CI Type Manager > Calculated Relatinships. HPE Universal CMDB (10.31) Page 44 f 300

45 Chapter 4: UCMDB Brwser Use Cases Enable a user t view r edit all CIs Read nly: Assign the glbal permissin View All t all CIs fr a rle. Read/Write: Assign the glbal permissin Edit All t all CIs fr a rle. Enable a user t view r edit nly specific CIs Read nly: Assign View permissin t specific views. Assign View All CIs permissin t a particular CI type. Nte: By default, in the UCMDB Brwser, the Party and Lcatin CI types are autmatically assigned View All CIs permissin. Read/Write: D ne f the fllwing: T edit all CIs that yu can view, assign Edit All CIs permissin n all views. T edit CIs in a specific view, assign Edit All CIs permissin n nly that view. T edit nly specific CI types in relevant views, assign Edit By CIT permissin t the views and Edit In View permissin t a particular CI type. Nte: Yu can assign permissins t a grup f views by selecting a nde in the list f Available Views, r apply the permissins t all views by selecting the Rt nde. T edit all CIs f a specific CI type, assign Edit All CIs permissin t that CI type. Enable a user t view all CIs and edit nly specific CIs Assign the glbal permissin View All t all CIs fr a rle. D ne f the fllwing: HPE Universal CMDB (10.31) Page 45 f 300

46 Chapter 4: UCMDB Brwser T edit all CIs f a specific CI type, assign Edit All CIs permissin t that CI type. T edit nly specific CIs: T edit all CIs that yu can view, assign Edit All CIs permissin n all views. T edit CIs in a specific view, assign Edit All CIs permissin n nly that view. T edit nly specific CI types in relevant views, assign Edit By CIT permissin t the views and Edit In View permissin t a particular CI type. Nte: Yu can assign permissins t a grup f views by selecting a nde in the list f Available Views, r apply the permissins t all views by selecting the Rt nde. T edit all CIs f a specific CI type, assign Edit All CIs permissin t that CI type. Hw t Change the UCMDB Integratin User Credentials Nte: This sectin is relevant nly fr the UCMDB Brwser standalne. The UCMDB Brwser cnnects t the UCMDB server thrugh the API using the UCMDB UI integratin user credentials. If yu changed the UCMDB integratin user credentials frm the initial default settings, perfrm the fllwing steps: 1. Create a credentials.txt tile and put it in the same directry as the ucmdb_brwser_cnfig.xml file. 2. In the file credentials.txt, enter the fllwing cntent: user=<user-name> passwrd=<user-passwrd> Where user-name is the integratin user's user name and user-passwrd is the integratin user's passwrd. 3. Restart the Tmcat server. Cautin: Fr multiple UCMDB cnfiguratins (as described in "Hw t Cnfigure Multiple UCMDB Servers" n page 49), the same integratin user shuld be defined n all UCMDB servers. Nte: After restarting the Tmcat server and then lgging in t the UCMDB Brwser, a new encrypted file credentials.bin is created and the file credentials.txt is remved. HPE Universal CMDB (10.31) Page 46 f 300

47 Chapter 4: UCMDB Brwser Hw t Cnfigure the UCMDB-UI Server URL If UCMDB is deplyed in a distributed cnfiguratin (in the case f Business Service Management users, when the Gateway and Data Prcessing servers are nt n the same machine), the UCMDB server URL shuld be defined t allw crrect access by direct links. T cnfigure the UCMDB server URL, add the fllwing t the ucmdb_brwser_cnfig.xml file: <ucmdb_ui_url> url> where [ucmdb-ui-server-name] is the UCMDB server name and [ucmdb-ui-prt] is the UCMDB- UI server prt. Hw t Cnfigure LW-SSO 1. Cnfigure all external applicatins that integrate with the UCMDB Brwser with LW-SSO settings. Fr details abut LW-SSO authenticatin, see the relevant sectin in ne f the fllwing dcuments: UCMDB Versin UCMDB UCMDB and later Dcument Name Hardening the HP Universal CMDB and Cnfiguratin Manager HPE Universal CMDB Hardening Guide Nte: If yu access the UCMDB Brwser by IP address (nt by FQDN), yu shuld add the UCMDB Brwser IP address t the UCMDB s trusted hsts. Yu can d this frm the JMX cnsle. Under LW-SSO Cnfiguratin Management, lcate the addtrustedips methd and invke it using the UCMDB Brwser IP address value. 2. Open the ucmdb_brwser_lwss_cnfig.xml file in the \cnf flder in an XML editr and make the fllwing changes: Fr the dmain tag, enter the dmain name f the UCMDB Brwser (fr example, net r dmain-name.cm). Fr the value f initstring, enter the exact value f initstring that is defined fr the UCMDB server and is retrieved when perfrming the prcedure described in the sectin Retrieving HPE Universal CMDB (10.31) Page 47 f 300

48 Chapter 4: UCMDB Brwser Current LW-SSO Cnfiguratin in Distributed Envirnment in the relevant dcument listed in step 1. Nte: In the case f an embedded UCMDB Brwser, cnfigure LW-SSO by ging t Administratin > Infrastructure Settings Manager > General Settings and cnfigure settings that start with LW-SSO. The UCMDB server name in the ucmdb_brwser_cnfig.xml file (under the <hst_name> tag) shuld be the full DNS name (fr example ucmdb-server.cm). When wrking with LW-SSO, the URL f the UCMDB Brwser shuld als cntain the dmain name (fr example When upgrading frm an lder versin t UCMDB Brwser 4.05 r later, pen the ucmdb_ brwser_lwss_cnfig.xml file in the \cnf flder, and replace the fllwing lines: <lguturls> <url>.*/lgut.jsp.*</url> </lguturls> with: <lguturls> <url>.*/lgut*</url> </lguturls> Hw t Cnfigure SSL Nte: If yu disable SSL supprt, yu cmprmise yur system's security. Yu will be vulnerable t data sniffing and ther security attacks. T install and cnfigure SSL supprt n Tmcat: 1. Create a keystre file t stre the server's private key and self-signed certificate by running ne f the fllwing cmmands: Fr Windws: %JAVA_HOME%\bin\keytl -genkey -alias tmcat -keyalg RSA Fr Unix: $JAVA_HOME/bin/keytl -genkey -alias tmcat -keyalg RSA Fr bth cmmands, use the passwrd value changeit (fr all ther fields in the cnsle dialg that pens, yu can use any value). HPE Universal CMDB (10.31) Page 48 f 300

49 Chapter 4: UCMDB Brwser 2. In the $CATALINA_BASE/cnf/server.xml file (where $CATALINA_BASE is the directry in which yu installed Tmcat), d the fllwing: Remve cmments frm the entry SSL HTTP/1.1 Cnnectr. Set prtcl="rg.apache.cyte.http11.http11prtcl" instead f prtcl="http/1.1". This cmmand defines a Java (JSSE) cnnectr, regardless f whether r nt the APR library is laded. Nte: This step is relevant nly fr the UCMDB Brwser installed n an existing Tmcat. Fr a full descriptin n hw t cnfigure server.xml t use SSL, see the Apache Tmcat fficial site: 3. Restart the Tmcat server. T use the HTTPS prtcl fr cnnectin t the UCMDB server: 1. In the ucmdb_brwser_cnfig.xml file, assign the value https t the tag<prtcl> and assign the UCMDB server HTTPS prt value (8443 by default) t the tag <prt>. 2. Dwnlad the UCMDB server public certificate t the UCMDB Brwser machine (if yu use SSL n the UCMDB server, the UCMDB administratr can prvide yu with this certificate), and imprt it int the cacerts trust stre n the JRE that is ging t cnnect t the server by running the fllwing cmmand: "%JAVA_HOME%\bin\keytl" -imprt -alias ucmdb -trustcacerts -file <UCMDB-Servercertificate-file> -keystre "%JAVA_HOME%\jre\lib\security\cacerts" where <UCMDB-Server-certificate-file> is the full path t the UCMDB server public certificate file. 3. Restart the Tmcat server. Hw t Cnfigure Multiple UCMDB Servers It is pssible t cnfigure the UCMDB Brwser t wrk with multiple UCMDB Servers. This is dne by replicating the sectin <ucmdb_cnfiguratin> </ucmdb_cnfiguratin> in the ucmdb_brwser_ cnfig.xml file, as shwn in the fllwing example: <ucmdb_cnfiguratin name="cnfiguratin-1"> <prtcl>https</prtcl> HPE Universal CMDB (10.31) Page 49 f 300

50 Chapter 4: UCMDB Brwser <hst_name>ucmdb-server-1</hst_name> <hst_prt>8443</hst_prt> <cntext_name>/</cntext_name> <custmer> <custmer_name>cmpany_a</custmer_name> <custmer_number>1</custmer_number> </custmer> </ucmdb_cnfiguratin> <ucmdb_cnfiguratin name="cnfiguratin-2"> <prtcl>https</prtcl> <hst_name>ucmdb-server-2</hst_name> <hst_prt>8443</hst_prt> <cntext_name>/</cntext_name> <custmer> <custmer_name>cmpany_b</custmer_name> <custmer_number>6</custmer_number> </custmer> </ucmdb_cnfiguratin> There is n limit t the number f UCMDB Servers that yu can add in this manner. Nte: The value f the name attribute in each cnfiguratin (fr example, cnfiguratin-1 r cnfiguratin-2 in the example abve) is ptinal, but if it is defined it must be a unique value. Yu can specify a default custmer by name, ID, r bth. If yu include the <custmer>...</custmer> tag, yu must prvide details fr it. On the lgin page f the UCMDB Brwser, nly the custmer that yu defined as the default custmer fr a particular UCMDB server will be visible in the drp-dwn list. Fr each cnfiguratin sectin, the custmers fr that UCMDB server are retrieved autmatically at the mment that the applicatin server starts, and a cnnectin fr each custmer is frmed using the value frm the name attribute in the ucmdb_cnfiguratin tag (if the name attribute is nt defined, the value frm the hst_name tag is used) and the name f the custmer. All these cnnectins appear in the drp-dwn list in the lgin screen. Fr example, in the case f the xml example abve, if cnfiguratin-1 has tw custmers and cnfiguratin-2 has three custmers, then the drp-dwn list will cntain five cnnectins, in the frm f: cnfiguratin-1 CustmerName1 cnfiguratin-1 CustmerName2 cnfiguratin-2 CustmerName1 HPE Universal CMDB (10.31) Page 50 f 300

51 Chapter 4: UCMDB Brwser cnfiguratin-2 CustmerName2 cnfiguratin-2 CustmerName3 If the UCMDB server defined in cnfiguratin-2 is inaccessible, then the cnnectin fr it is still visible in the drp-dwn list (withut any custmer infrmatin), even if the user cannt lgin using that server. In that case, the list will cntain the cnnectins: cnfiguratin-1 CustmerName1 cnfiguratin-1 CustmerName2 cnfiguratin-2 If nly ne server is available, then the server name des nt appear in the cnnectin name. Cautin: If yu have launched the UCMDB Brwser with a given UCMDB server, yu cannt pen anther instance f the UCMDB Brwser with a different UCMDB server with the same web brwser. Yu can, hwever, pen anther instance f the UCMDB Brwser with a different UCMDB Server if yu use a different web brwser. Fr example, if yu pened the UCMDB Brwser with Internet Explrer with a given UCMDB server, yu can pen the UCMDB Brwser using Ggle Chrme with anther UCMDB server. Nte: The same LW-SSO settings frm the ucmdb_brwser_lwss_cnfig.xml file are used fr all UCMDB cnfiguratins. Hw t Specify Data Stres Used fr Data Lading The flag federated_search_enabled is used t enable r disable the use f federatin regarding several peratins in the UCMDB Brwser. If this flag is set t False (this is the default value), the legacy search engine, and the widgets use nly the lcal data stre fr gathering data. If this flag is set t True, all data stres are used when running a search in the legacy search engine and the widgets. Set the federated_search_enabled flag 1. In UCMDB, g t Administratin > Infrastructure Settings Manager, and chse UCMDB Brwser settings. 2. In the Name clumn, chse Shw federated search results. 3. In the Value clumn, chse True r False frm the drp-dwn list. HPE Universal CMDB (10.31) Page 51 f 300

52 Chapter 4: UCMDB Brwser 4. Click Save. Limitatins n Using Federated Data The use f federated data has the fllwing limitatins: The Envirnment widget cannt lad data frm a cmpletely remte CI (that is, a CI that exists nly in a remte data stre and des nt exist in the lcal data stre). Fr cmpletely remte CIs, the Prperties widget des nt display prperties calculated frm related CIs. Hw t Change the Default Prt f the Tmcat Server The default prt value (8443) f the Tmcat Server may cnflict with an existing applicatin (fr example, anther web applicatin already uses this prt). If such a cnflict exists, change the default prt as fllws: 1. Lcate the file server.xml in $CATALINA_BASE/cnf/ where $CATALINA_BASE is the directry in which yu installed Tmcat. 2. In server.xml, find a statement similar t the fllwing: r <Cnnectr prt="8443" maxhttpheadersize="8192" maxthreads="150" minsparethreads="25" maxsparethreads="75" enablelkups="false" redirectprt="8080" acceptcunt="100" cnnectintimeut="20000" disableupladtimeut="true" /> <Cnnectr prt="8443" prtcl="http/1.1" cnnectintimeut="20000" redirectprt="8080" /> 3. Change the Cnnectr prt= 8443 prt t any ther prt number. Fr example: <Cnnectr prt="8181" prtcl="http/1.1" cnnectintimeut="20000" redirectprt="8080" /> 4. Save the server.xml file and restart the Tmcat server. HPE Universal CMDB (10.31) Page 52 f 300

53 Chapter 4: UCMDB Brwser Hw t Deply the UCMDB Brwser with a Different Rt Cntext Yu can change the default rt cntext name /ucmdb-brwser. T d this, rename ucmdbbrwser.war under <Tmcat installatin path>\webapps. Fr example, if yu want t change the cntext name t /nice-applicatin, rename ucmdbbrwser.war t nice-applicatin.war. Yu can als create a multilevel cntext name. Fr example, if yu want t change the cntext name t /very/very/nice-applicatin, rename ucmdb-brwser.war t very#very#nice-applicatin.war. Hw t Upgrade the UCMDB Brwser If yu have a versin f the UCMDB Brwser that is lder than the current versin, yu can upgrade t the latest versin as fllws: 1. Unzip ne f the fllwing files t an accessible lcatin (depending n the type f installatin yu have): If the Brwser is installed n the same machine that runs the UCMDB server: HPE- Brwser-<versin_number>.<build_number>-ucmdb-brwser-embedded.zip Imprtant: Yu can upgrade the embedded UCMDB Brwser t the versin 4.10, nly if the versin f the UCMDB server is Yu can upgrade the embedded UCMDB Brwser t the versin 4.12, nly if the versin f the UCMDB server is Fr all ther installatins: HPE-Brwser-<versin_number>.<build_number>-ucmdbbrwser-standalne.zip 2. Stp the web applicatin (Tmcat r UCMDB Server). 3. Clear the user preferences fr the users that have scheduled reprts as fllws: a. G t JMX Cnsle > UCMDB-UI:name=User Preferences > clearuserpreferences. b. In the user name field, enter the user's name. c. Click Invke. HPE Universal CMDB (10.31) Page 53 f 300

54 Chapter 4: UCMDB Brwser 4. Delete the ld ucmdb-brwser.war file as fllws: If the Brwser is installed n the same machine that runs the UCMDB server: Delete the file ucmdb-brwser.war frm the flder %UCMDB-Server%deply/, where %UCMDB- Server% is the UCMDB server rt flder. Fr all ther installatins: Delete ucmdb_brwser.war frm <Tmcat installatin path>\webapps. Als, in <Tmcat installatin path>\webapps delete the ucmdb_brwser flder. 5. Cpy the new ucmdb-brwser.war file t the apprpriate lcatins as fllws: If the Brwser is installed n the same machine that runs the UCMDB server: Cpy the file ucmdb-brwser.war t %UCMDB-Server%deply/. Clear the ucmdb-brwser.war flder frm C:\hp\UCMDB\UCMDBServer\runtime\jetty-cache befre starting the UCMDB server. Fr all ther installatins: Cpy ucmdb_brwser.war t <Tmcat installatin path>\webapps. Nte: If the server is running, use a cut-and-paste peratin t put the new WAR file in place, rather than cpy-and-paste. Using cut-and-paste cpies the file instantly and causes the server t deply the full applicatin (instead f pssibly deplying an incmplete WAR file). %UCMDB-Server% is the UCMDB server rt flder. Fr example: C:\hp\UCMDB\UCMDBServer. 6. Cpy the necessary update resurces, depending n the type f installatin yu have, as fllws: If yu have yur wn Tmcat installatin, cpy the setenv.bat file t the bin flder. If yu installed the UCMDB Brwser with Precnfigured Apache Tmcat Server n Linux, cpy the setenv.sh file t the bin flder. If yu installed the UCMDB Brwser with Precnfigured Apache Tmcat Server n Windws, cpy the update_ucmdb_brwser_service.bat file t the rt flder f yur installatin (the same place where the install_ucmdb_brwser_service.bat is lcated) and run it. 7. Read the release ntes fr the latest versin t determine which features and functinality yu want t use and update yur Brwser settings accrdingly. 8. Open the ucmdb_brwser_lwss_cnfig.xml file in the \cnf flder, and replace the fllwing lines: <lguturls> <url>.*/lgut.jsp.*</url> HPE Universal CMDB (10.31) Page 54 f 300

55 Chapter 4: UCMDB Brwser </lguturls> with: <lguturls> <url>.*/lgut*</url> </lguturls> Nte: The abve step is available fr UCMDB Brwser standalne, when upgrading frm an lder versin t UCMDB Brwser 4.05 r later versins. 9. Check if the fllwing lines exist in the <Tmcat installatin path>\cnf\cntext.xml file, and delete them: <JarScanner> <JarScanFilter defaultpluggabilityscan="false" /> </JarScanner> 10. Start the Tmcat server r UCMDB server (depending n yur installatin). All features and functinality frm the previus installatin are active in the new installatin, as well as the new features and functinality fr the latest versin. Hw t Cnfigure an Envirnment t Use Multiple Reverse Prxies When clients are cnnected t the same UCMDB Brwser instance thrugh multiple reverse prxies, the UCMDB Brwser needs t knw each client s frntend URL t build crrect direct links t the HPE Cnfiguratin Manager and HPE Service Manager servers. Fr example, a client wh accesses the UCMDB Brwser by reverse prxy shuld get a direct link by the same Therefre, a cnfiguratin based n relative URLs instead f full URLs shuld be implemented. When the UCMDB-Brwser receives a request with a header X-Reverse Prxy, it relates t applicatin URLs as relative URLs and cncatenates part f the header with a relative URL. T use this slutin the custmer shuld: 1. Cnfigure each reverse prxy in the envirnment t append header X-Reverse-Prxy with the Reverse Prxy s frntend URL. 2. Use a relative URL fr all servers behind the reverse prxy in the UCMDB-Brwser cnfiguratin. HPE Universal CMDB (10.31) Page 55 f 300

56 Chapter 4: UCMDB Brwser T perfrm the actual cnfiguratin: 1. Cnfigure reverse prxy t append header X-Reverse-Prxy with the reverse prxy URL fr Apache-server. T d this, pen file %apache-hme-directry%\cnf\httpd.cnf (where %apachehme-directry% is the Apache server hme directry), and add the fllwing lines: LadMdule headers_mdule mdules/md_headers.s RequestHeader set X-Reverse-Prxy Where is the entire reverse prxy s frntend URL. 2. The UCMDB Brwser cnfiguratin file shuld use relative URLs instead f full URLs. Fr example, instead f use /cnc. Specifically, it is very imprtant that the value f tag <ucmdb_ui_url> is defined and uses a relative path. Hw t Cnfigure the Enhanced Search Engine The Enhanced CI search engine translates free text queries t TQL queries, with much better perfrmance and accuracy than the legacy search engine and flexible searching language. The syntax f the search queries is based n the class mdel. Nte: The Enhanced CI search engine des nt supprt any f the class mdel cnfiguratins used by the legacy search engine. The search engine can be cnfigured in the fllwing three areas: Indexing. Cnfigure what is indexed, which CI types are "searchable", which attributes are "searchable", and what are types f the attributes. This cnfiguratin is perfrmed with the Search_ Indexer_Cnfiguratin_XML and Search_Ranking_Cnfiguratin_XML files. This cnfiguratin file includes a list f class types that are indexed and a list f attributes fr each ne f the class types. This cnfiguratin influences the manner in which the search by prperty cnditin is perfrmed. Parsing. Cnfigure class mdel synnyms. Synnyms translate the user input string query int a graph structure, TQL. This cnfiguratin is perfrmed with the Search_Parser_Cnfiguratin_ XML file. This cnfiguratin file includes a set f class synnyms, attribute synnyms, date synnyms, relatin synnyms, and a set f redundant wrds. Nte: The list f redundant wrds must cntain nly single wrds, with n spaces (n phrases are permitted). HPE Universal CMDB (10.31) Page 56 f 300

57 Chapter 4: UCMDB Brwser Ranking. Cnfigure which CI types are presented and the rder f presentatin. Priritizatin is accrding t class mdel. This cnfiguratin is perfrmed with the Search_Ranking_ Cnfiguratin_XML file. This cnfiguratin file cntains a list f attributes that are assciated with five data fields, called data0, data1, data2, data3, and data4. These fields are priritized, where data4 has the highest pririty and data0 has the lwest pririty. This cnfiguratin influences the rder f CIs in the search results. The UCMDB Brwser can be used ut-f-the-bx withut initial cnfiguratin f the search engine. Hwever, if an attribute is nt in the Indexer r Ranking lists, it des nt appear in the search results. Mdify the currently indexed list Enable/Disable the Enhanced Search Engine 1. G t JMX Cnsle > UCMDB:service=Tplgy Search Services. 2. Chse ne r mre f the fllwing peratins: editindexercnfiguratin displays and enables editing f the Search_Indexer_ Cnfiguratin_XML file. editparsercnfiguratin displays and enables editing f the Search_Parser_ Cnfiguratin_XML file. editrankingcnfiguratin displays and enables editing f the Search_Ranking_ Cnfiguratin_XML file. 3. Fr each peratin, enter the relevant custmer ID and click Invke. Fr the enhanced search engine t wrk, it must be enabled in UCMDB. By default, it is enabled (unless it was disabled during UCMDB installatin). T change the enable/disable setting: 1. G t JMX Cnsle > UCMDB:service=Settings Services > setglbalsettingvalue. 2. In the name field enter cmdb.search.enabled. 3. In the value field enter: true: If yu want the search enabled. false: If yu want the search disabled. HPE Universal CMDB (10.31) Page 57 f 300

58 Chapter 4: UCMDB Brwser 4. Click Invke. 5. Restart the UCMDB server. Nte: If yu disable the Enhanced Search Engine, the UCMDB Brwser autmatically reverts t the legacy search engine. Enable/Disable Searching fr Federated Data The enhanced search engine can be cnfigured t perfrm searches n federated data. By default, it is disabled. T enable searching fr federated data, yu must set the "federated search enable" flag t True in the JMX Cnsle and in the UCMDB Infrastructure Settings Manager. Enable r disable searching fr federated data (Enhanced Search Engine) Yu can enable r disable searching fr federated data when the Enhanced Search Engine is enabled, in the JMX Cnsle r in the UCMDB Infrastructure Settings Manager. Enable r disable searching fr federated data in the JMX cnsle: 1. G t JMX Cnsle > UCMDB:service=Settings Services > setsettingvalue. 2. In the name field enter cmdb.federatin.search.enabled. 3. In the value field enter: true: If yu want t enable searching federated data. false: If yu want t disable searching federated data. 4. Click Invke. 5. Restart the UCMDB server. Enable r disable searching fr federated data in the UCMDB Infrastructure Settings Manager: 1. In UCMDB, g t Administratin > Infrastructure Settings Manager, and chse General Settings. 2. In the Name clumn, chse Federatin in Search Engine Enabled. 3. In the Value clumn, chse True r False frm the drp-dwn list. 4. Click Save. HPE Universal CMDB (10.31) Page 58 f 300

59 Chapter 4: UCMDB Brwser Enable r disable searching fr federated data in the UCMDB Infrastructure Settings Manager (Legacy Search Engine and widgets) Fllw the instructins in the sectin "Hw t Specify Data Stres Used fr Data Lading" n page 51. Enable searching f federated CIs by CI display name T search fr a federated CI by the CI display name (r sub-string f the display name), the CI type must be assigned the qualifier CMS_BROWSER_SEARCH in the CI Type Manager. Specific Cnfiguratin Optins Cnfigure Search by Data In the Search_Ranking_Cnfiguratin_XML file, yu can assciate attributes f a CI t a data field accrding t the data field pririty. This enables a search f the values f thse CI attributes and affects the rder f CIs returned in the search results. Cnfigure Search by Tplgy In the Search_Parser_Cnfiguratin_XML file, yu can cnfigure relatinship synnyms that assciate phrases with class types. Fr example, in the example belw, the phrase "wned by" is assciated with the class type "persn". <relatinship> <synnym>wned by</synnym> <classname>persn</classname> </relatinship> As a result f the abve cnfiguratin, if the user enters the search query "all windws wned by Jhn", the search engine lks fr all windws CIs that are cnnected t a CI f type 'persn' with the name 'Jhn'. Cnfigure Search by Path In the Search_Parser_Cnfiguratin_XML file, yu can define cmpund classes by inserting a list f class types. In the example belw, all the class types in the <string> tag make up the cmpund class, which triggers the search by path. If this list is empty, n search by path is initiated. HPE Universal CMDB (10.31) Page 59 f 300

60 Chapter 4: UCMDB Brwser Yu can change the number f linked paths thrugh which yu want t search, starting frm the riginal search term. T d this, g t the Infrastructure Settings Manager in UCMDB and change the Search Engine Cmpund Depth setting t the value yu want. Fr details, see "Infrastructure Settings Manager" n page 150. <cmpundclasses> <string>msdmain</string> <string>persn</string> <string>suser</string> <string>lcatin</string> <string>business_element</string> <string>cluster</string> <string>party</string> </cmpundclasses> Cnfigure Search by Cardinality Cnditin In the Search_Parser_Cnfiguratin_XML file, yu can define a set f cardinality synnyms that assciate phrases with cardinality types. Fr example, if yu define <cardinalitysynnym cardinalitytype="min" cardinalityphrase="with at least"/> and then a user enters the search query "all NT with at least 2 CPUs", the search engine lks fr all CIs with class type 'NT' that have tw r mre CIs f type CPU related t them. The ut-f-the-bx cardinality synnyms are as fllws: <cardinalitysynnyms> <cardinalitysynnym cardinalitytype="min" cardinalityphrase="min"/> <cardinalitysynnym cardinalitytype="min" cardinalityphrase="with minimum"/> <cardinalitysynnym cardinalitytype="equal" cardinalityphrase="with"/> <cardinalitysynnym cardinalitytype="max" cardinalityphrase="max"/> <cardinalitysynnym cardinalitytype="max" cardinalityphrase="with maximum"/> <cardinalitysynnym cardinalitytype="min" cardinalityphrase="minimum"/> <cardinalitysynnym cardinalitytype="max" cardinalityphrase="befre"/> <cardinalitysynnym cardinalitytype="max_excluded" cardinalityphrase="with less than"/> <cardinalitysynnym cardinalitytype="equal" cardinalityphrase="with exactly"/> <cardinalitysynnym cardinalitytype="min" cardinalityphrase="with at least"/> <cardinalitysynnym cardinalitytype="min_excluded" cardinalityphrase="with mre then"/> <cardinalitysynnym cardinalitytype="min" cardinalityphrase="since"/> <cardinalitysynnym cardinalitytype="min" cardinalityphrase="frm"/> <cardinalitysynnym cardinalitytype="min" cardinalityphrase="at least"/> HPE Universal CMDB (10.31) Page 60 f 300

61 Chapter 4: UCMDB Brwser <cardinalitysynnym cardinalitytype="max" cardinalityphrase="till"/> <cardinalitysynnym cardinalitytype="not" cardinalityphrase="withut"/> <cardinalitysynnym cardinalitytype="min_excluded" cardinalityphrase="with mre than"/> <cardinalitysynnym cardinalitytype="min" cardinalityphrase="after"/> <cardinalitysynnym cardinalitytype="max" cardinalityphrase="with at mst"/> <cardinalitysynnym cardinalitytype="max" cardinalityphrase="maximum"/> <cardinalitysynnym cardinalitytype="max_excluded" cardinalityphrase="with less then"/> <cardinalitysynnym cardinalitytype="max" cardinalityphrase="at mst"/> </cardinalitysynnyms> Cnfigure Search by Prperty Cnditin This search is based n attribute synnyms. In the Search_Parser_Cnfiguratin_XML file, yu can define synnyms fr the CI attribute names that are defined in UCMDB. In the fllwing example, the CI attribute display_label has fur different synnyms defined fr it: <attributesynnym> <synnym>name</synnym> <attributes> <attributename>display_label</attributename> </attributes> </attributesynnym> <attributesynnym> <synnym>display label</synnym> <attributes> <attributename>display_label</attributename> </attributes> </attributesynnym> <attributesynnym> <synnym>display</synnym> <attributes> <attributename>display_label</attributename> </attributes> </attributesynnym> <attributesynnym> <synnym>label</synnym> <attributes> <attributename>display_label</attributename> </attributes> </attributesynnym> Anther type f search by prperty cnditin ccurs when a cardinality synnym is fllwed by a number, which can als include a unit. Fr example, if the user enters the search input text windws HPE Universal CMDB (10.31) Page 61 f 300

62 Chapter 4: UCMDB Brwser with at least 4GB memry, since memry is a synnym fr the attribute types memry_size and nt_physical_memry as shwn in the cde example belw, this triggers a search by prperty cnditin. <attributesynnym> <synnym>memry</synnym> <attributes> <attributename>memry_size</attributename> <attributename>nt_physicalmemry</attributename> </attributes> </attributesynnym>... <unit> <multiplyby> </multiplyby> <synnym>gigabytes</synnym> <synnym>g</synnym> <synnym>giga</synnym> <synnym>gb</synnym> </unit> Yu can add additinal synnyms fr cardinality phrases, synnyms fr attribute names, and synnyms fr unit types in rder t refine this type f search. In the example abve, the memry size attribute is stred in bytes, and in rder t search by gigabytes, the search engine uses the cnversin defined in the <multiplyby> tag (this definitin is prvided ut-f-the-bx). In additin t the cnversin fr gigabytes, ut-f-the-bx cnversins are als prvided fr megabytes and kilbytes. Nte: Units and numbers are runded accrding t the range definitins defined by the Use Update Value Plicy qualifier. Fr mre infrmatin n setting range definitins, see "The Use Update Value Plicy Qualifier" in the HPE Universal CMDB Mdeling Guide. Cnfigure Search by Categry In the Search_Parser_Cnfiguratin_XML file, yu can specify labels t be used when searching fr CIs. In the fllwing example, the labels "categry" and "clr" enable yu t search fr the strings all windws clr green and all servers categry editable. <categrylabelsynnyms> <categrylabelsynnym>categry</categrylabelsynnym> </categrylabelsynnyms> <categryclrsynnyms> <categryclrsynnym>clr</categryclrsynnym> HPE Universal CMDB (10.31) Page 62 f 300

63 Chapter 4: UCMDB Brwser </categryclrsynnyms> Cnfigure Class Name Cnditins In the Search_Parser_Cnfiguratin_XML file, yu can create synnyms fr class names. In the fllwing example, the synnym "windws" was created fr the class name "nt". <classsynnym> <synnym>windws</synnym> <classname>nt</classname> </classsynnym> Cnfigure String Replacement In the Search_Parser_Cnfiguratin_XML file, yu can cnfigure string replacements. The cde example belw enables the search engine t retrieve all ndes that have the attribute Hst is virtual set t True. The CI prperty 'hst_isvirtual' is a blean prperty, and is true if the nde is virtual, but the user des nt need t knw this and this string replacement cnverts his search query withut the user knwing these details. <replace> <frm>virtual nde</frm> <t>nde hst_isvirtual true</t> </replace> String replacement can be implemented using the '%' wildcard character. With the fllwing cde example, if the user enters the search query "linux ndes" r "linux machine", the search engine cnverts this t "ndes versin linux" and machine versin linux, respectively. <replace> <frm>linux %1</frm> <t>%1 versin linux</t> </replace> Cnfigure Enriching Capability The enriching mechanism executes enriching queries ver the search results. Enriching queries are defined in tw ways, ne is user-defined and the ther is based n existing flding rules. The enriching mechanism reviews the CIs in the search results and extends the results by applying each ne f the enriching queries as a perspective ver the CI. The enriching prcess is executed repeatedly, where after each executin search results are received and then enriched again by the HPE Universal CMDB (10.31) Page 63 f 300

64 Chapter 4: UCMDB Brwser enriching TQLs, which in turn prduces mre search results. By default, this prcess is repeated 3 times, but this can be changed by means f the cmdb.search.enriching.depth parameter. Fr instructins n cnfiguring this parameter, see "Cnfigure Repetitin f the Enriching Mechanism" n the next page. User-Defined Enriching Queries T create user-defined enriching queries: 1. In UCMDB, g t Mdeling > Mdeling Studi and click New. 2. Frm the drp-dwn list, select Query. The Query Definitin editr pens. 3. Click Query Definitin Prperties. The Query Definitin Prperties dialg bx pens. 4. In the Type field, select Perspective frm the drp-dwn list. 5. In the Bundles field, click Select Bundles. 6. Frm the Bundles list, select search_result_enriching_tqls and click OK. 7. Define the query accrding t yur system needs. 8. Define ne f the ndes f the query as Set as Cntact Query Nde. The query definitin is similar t the perspective definitin and therefre shuld include at least ne cntact nde, where the cntact nde is the CI that shuld be enriched. There are als tw ut-f-the-bx enriching queries prvided in the Mdeling Studi. Yu can view and edit them as fllws: 1. G t Mdeling > Mdeling Studi, and select the Resurces tab. 2. Frm the Resurces Type drp-dwn list, select Queries. 3. In the list f queries, g t Search Engine > Enriching TQLs. 4. Under Enriching TQLs, chse ne f the enriching queries. Yu can view it and edit it accrding t yu system needs. Enriching Queries Based n Existing Flding Rules As mentined abve, in additin t the user-defined enriching queries, there is an existing set f predefined enriching queries based n flding rules. T view, add, r edit enriching queries based n flding rules: 1. G t Mdeling > CI Type Manager. 2. Frm the CI Types drp-dwn list, chse Calculated Relatinships. HPE Universal CMDB (10.31) Page 64 f 300

65 Chapter 4: UCMDB Brwser 3. In the list f Calculated Links, select Flding Rules (Cnfiguratin Manager). 4. Select the Triplets tab n the upper right. The list f Triplets appears. Frm each ne f the listed triplets there is an autmatic mechanism that creates at run-time an enriching query. It enriches the Target CI type by the Surce CI type. In this case, the Target CI type is the cntact nde f the query. 5. T add a new triplet, click Add. If yu select the frward relatinship directin (frm Surce t Target), the Target CI type is enriched by the Surce CI type. If yu select the backward relatinship directin (frm Target t Surce), the Surce CI type is enriched by the Target CI type. 6. T edit a triplet, select the triplet in the list and click. Nte: T disable the use f flding rules, change the Specify whether Search Engine Enriching shuld use flding rules setting in the Infrastructure Settings Manager t False. Cnfigure Repetitin f the Enriching Mechanism T cnfigure the number f times that enriching is perfrmed n search results: 1. G t JMX Cnsle > UCMDB:service=Settings Services > setsettingvalue. 2. In the name field enter cmdb.search.enriching.depth. 3. In the value field enter the number f times that yu want enriching t be repeated n search results. 4. Click Invke. 5. Restart the UCMDB server. Nte: Changing the cmdb.search.enriching.depth parameter value t a higher value can intrduce perfrmance issues due t generating a large search result. Versin added fuse cmdb.search.max.query.max.results t prtect against perfrmance issues when the enriching prcess is dne during UCMDB Brwser Search. The number f results retrieved during enriching is limited by the value specified fr the cmdb.search.max.query.max.results parameter. In case this setting is nt present, the default is When the max number f recrds retrieved thrugh enriching (cmdb.search.max.query.max.results value) is reached, the value f cmdb.search.enriching.depth is n lnger taken int cnsideratin and the enriching prcess is stpped. HPE Universal CMDB (10.31) Page 65 f 300

66 Chapter 4: UCMDB Brwser Cnfigure Redundant Wrds There is a set f wrds that the search engine ignres when parsing the search query. T cnfigure this list, g t the Search_Parser_Cnfiguratin_XML file and g t the <blacklist> sectin. Add t r edit the list as needed. The current list f redundant wrds is a fllws: <blacklist> <blacklistitem>t</blacklistitem> <blacklistitem>such as</blacklistitem> <blacklistitem>with</blacklistitem> <blacklistitem>fr</blacklistitem> <blacklistitem>r</blacklistitem> <blacklistitem>a</blacklistitem> <blacklistitem>the</blacklistitem> <blacklistitem>like</blacklistitem> <blacklistitem>in</blacklistitem> <blacklistitem>and</blacklistitem> <blacklistitem>f</blacklistitem> <blacklistitem>if</blacklistitem> <blacklistitem>an</blacklistitem> <blacklistitem>n</blacklistitem> <blacklistitem>linked</blacklistitem> <blacklistitem>all</blacklistitem> </blacklist> Cnfigure Search f CIs Changed in a Specific Time Perid In the Search_Parser_Cnfiguratin_XML file, there are a sets f wrds defined as mnth-name synnyms and day-name synnyms. Fr example: <mnthsynnym> <mnthname>january</mnthname> <mnthnumber>0</mnthnumber> </mnthsynnym> <mnthsynnym> <mnthname>jan</mnthname> <mnthnumber>0</mnthnumber> </mnthsynnym>... <daysynnym> HPE Universal CMDB (10.31) Page 66 f 300

67 Chapter 4: UCMDB Brwser <dayname>sunday</dayname> <daynumber>1</daynumber> </daysynnym> <daysynnym> <dayname>sun</dayname> <daynumber>1</daynumber> </daysynnym> Values in the tags <mnthnumber> and <daynumber> shuld nt be mdified. These cnfiguratins allw supprt f search queries like all windws created last Sunday and all ndes changes between August 8th 1980 and 25/5/2011. Cnfigure Date Frmat The search engine supprts tw dates frmats: day-mnth-year (DMY) and mnth-day-year (MDY), which can be cnfigured as fllws: 1. G t JMX Cnsle > UCMDB:service=Settings Services > setsettingvalue. 2. In the name field enter: cmdb.search.date.frmat. 3. In the value field enter the desired date frmat: DMY, MDY, r bth. 4. Click Invke. 5. Restart the UCMDB server. Cnfigure Autcmpletin In the Search_Autcmpletin_Cnfiguratin_XML file, yu can expand the UCMDB Brwser's search capabilities by cnfiguring the UCMDB server t suggest matches fr substrings f wrds in a search, including CI attribute values. 1. G t JMX Cnsle > UCMDB:service=URM Services > listresurcetypes and click Invke. 2. Click Tplgy_AUTOCOMPLETION_CONFIGURATION. 3. Click Search_Autcmpletin_Cnfiguratin_XML. 4. Enter the fields f classes that yu want t index fr autcmpletin. Since the class name supprts inheritance, yu can enter the fllwing: <supprtedautcmpletinfields> <autcmpletinfield> HPE Universal CMDB (10.31) Page 67 f 300

68 Chapter 4: UCMDB Brwser <classname>managed_bject</classname> <attributename>display_label</attributename> </autcmpletinfield> </supprtedautcmpletinfields> r, fr example: <supprtedautcmpletinfields> <autcmpletinfield> <classname>nt</classname> <attributename>display_label</attributename> </autcmpletinfield> <autcmpletinfield> <classname>unix</classname> <attributename>display_label</attributename> </autcmpletinfield> </supprtedautcmpletinfields> 5. Click Save resurce. Cnfigure Query Search Filter By default, the search algrithm filters ut the queries that are t general. If yu wish t turn ff the filter, fllw these steps: 1. G t JMX Cnsle > UCMDB:service=Settings Services > setsettingvalue. 2. In the name field, enter cmdb.search.filter.queries. 3. In the value field, enter false. Nte: Enter true if yu want t turn n the filter. 4. Click Invke. Perfrm a Full Reindex f All CIs Use either f the fllwing appraches t perfrm a full reindex f all CIs available fr search in the UCMDB Brwser: G t JMX Cnsle > UCMDB:service=Tplgy Search Services and invke the reindex() methd. HPE Universal CMDB (10.31) Page 68 f 300

69 Chapter 4: UCMDB Brwser This methd remves all CIs infrmatin stred inside the SOLR index files withut remving any internal SOLR files. Nte: Yu can als invke the reindexcitype() methd t re-index all the CIs f a given CI type frm the CMDB mdel database. Fr mre infrmatin, refer t the HPE Universal CMDB JMX Reference Guide. Stp the UCMDB server, delete the <UCMDB_Server_Hme>/search flder, and then start the UCMDB server. The deletin f the flder frces a full reindex fr all UCMDB custmers and reverts the SOLR cnfiguratin t the ut f the bx values. This prcess remves all internal SOLR files and hence takes lnger time than the previus ne. Trubleshting - Cnfigure the Enhanced Search Engine UCMDB desn t start because f the search subsystem manager. What d I d? Stp UCMDB, delete the flder <UCMDB installatin flder>/search, then restart UCMDB. If the search still des nt start, disable it, as explained in "Enable/Disable the Enhanced Search Engine" n page 57 and revert t the legacy search engine. The search desn t return any results. In the Tplgy Search JMX, invke the fllwing methds: restrefactrydefaults: This restres factry cnfiguratin fr the search. reindex: This recreates a search index fr CIs in the UCMDB mdel. Nte, this can take up t several hurs fr large databases (apprx 1M CIs/hur). Yu can als invke the reindexcitype methd t re-index all the CIs f a given CI type frm the CMDB mdel database. The search desn't find CI types that I want. There are several different pssible causes fr this. Check the fllwing: HPE Universal CMDB (10.31) Page 69 f 300

70 Chapter 4: UCMDB Brwser Check that the attribute and CI type are indexable accrding t the indexing cnfiguratin. If they are nt, add the class attributes cnfiguratin item as explained "Mdify the currently indexed list" n page 57. Check that yu have crrect synnyms defined fr the class in Class synnyms. Check that rating and pageitemcunt fr this CI are nn-zer. Check fr rating in the Attribute ranking and fr pageitemcunt in Presentable CI types. Cardinality cnditins dn't wrk r return incrrect results. In additin t checking attribute synnyms, check that the attribute type is defined as numeric in Indexing Cnfiguratin and that units cnfiguratin matches attribute units in Search_Parser_ Cnfiguratin_XML. The search presents t many unwanted results. Check if yu are yu using queries with natural language. This can limit results f the "best guess" f what the user intended. If yu need t be 100% certain that yur query returns results nly f ne specific CI type, use type: ci-type filter in the query. If the tw suggestins abve dn't help, cntact the R&D team with yur use case and status reprt frm JMX. Prblem with cnfiguratin - restre factry defaults T restre the default cnfiguratin XML files frm the factry cntent, g t JMX Cnsle > UCMDB:service=Tplgy Search Services and invke the restrefactrydefaults() methd. Cautin: This methd verwrites the current cnfiguratin. Yu shuld back up the cnfiguratin files befre invking it. Lgs and debugging inf Lgs search.lg lgs everything related t searches. Default lg level is INFO, nly statistics are printed. The lg level and number f lgs are cnfigured with the search.lglevel variable in cnf/lg/cmdb.prperties. HPE Universal CMDB (10.31) Page 70 f 300

71 Chapter 4: UCMDB Brwser Status Reprt The tplgy search JMX status reprt displays all current cnfiguratin tables and statistics fr the search engine cmpnent. It is useful t include it when reprting issues t R&D. Cntent f Slr Database By default, the Slr search engine is embedded inside UCMDB server. T query it directly, g t JMX Cnsle > UCMDB:service=Tplgy Search Services and invke the debugslrquery() methd. Example queries: empty query returns all CIs "id:a6693cd46cfd1b4fab0c3551bac9289e" returns a CI with cmdbid a6693cd46cfd1b4fab0c3551bac9289e. This uses Slr/Lucene syntax. Hw t Brand the UCMDB Brwser The majrity f UCMDB Brwser installatins are delivered with Hewlett Packard Enterprise branding. Hwever, yu have the ability t apply a header and fter, add custm text and an icn in the header f the UCMDB Brwser, and replace the image that appears n the landing page. In all UCMDB Brwser installatins, the <UCMDB_Brwser_installatin_directry> \webapps\ucmdb-brwser\public\branding flder cntains sample icn, image, and stylesheet files. Yu can replace r update these files as desired, and specify their lcatin in the settings in UCMDB, as described belw. Recmmended image sizes are: fr icns - 20 x 20 pixels fr the landing page image x 135 pixels Example f the CSS stylesheet:.bannerclass { backgrund-clr: yellw; clr: blue; fnt-weight: bld; fnt-style:italic; } T brand the UCMDB Brwser: HPE Universal CMDB (10.31) Page 71 f 300

72 Chapter 4: UCMDB Brwser 1. In UCMDB, g t Administratin > Infrastructure Settings Manager, and chse UCMDB Brwser settings. 2. Update the fllwing settings as required: Name Banner stylesheet URL Banner text Custm masthead text Custm icn fr masthead Custm image fr landing page Value The URL f the stylesheet used fr the banner text. The text that will appear in the header and fter. Custmized text that will appear in the masthead f the UCMDB Brwser. The URL f the icn that will appear in the masthead f the UCMDB Brwser. The URL f the image that will appear n the landing page f the UCMDB Brwser. Nte: Fr the best visual effect, use a graphic with a transparent backgrund. Custm prduct name The name f the prduct that will appear n the landing page f the UCMDB Brwser. Nte: If yu specify custmized text and an icn fr the masthead, they will appear in additin t the current Hewlett Packard Enterprise text and image, and nt as replacements. 3. Click Save. Hw t Set UCMDB Brwser Sessin t Expire T set a UCMDB Brwser sessin t expire when LW-SSO is enabled, 1. In UCMDB, g t Administratin > Infrastructure Settings Manager. 2. With all categries f infrastructure settings displayed, select Name fr the Filter by clumn field, and enter LW-SSO in the field next t it t display all LW-SSO settings. 3. Check if the LW-SSO ckie expiratin perid setting value is smaller than the LW-SSO ping interval setting value. (Bth f the settings are expressed in minutes.) HPE Universal CMDB (10.31) Page 72 f 300

73 Chapter 4: UCMDB Brwser If nt, mdify the values fr the tw settings t ensure that LW-SSO ckie expiratin perid is smaller than the LW-SSO ping interval. When LW-SSO ping interval is lwer than LW-SSO ckie expiratin perid, this means that the sessin will never expire. The ping will keep the sessin active. 4. Click Save. 5. Restart UCMDB Server. HPE Universal CMDB (10.31) Page 73 f 300

74 Administratin HPE Universal CMDB (10.31) Page 74 f 300

75 Chapter 5: UCMDB Server Administratin This chapter includes: Basic Administratin Tasks 76 Hw t Enable HTTP Cmmunicatin fr UCMDB Server 77 Hw t Access the JMX Cnsle 78 Hw t Enable Remte Access t the JMX Cnsle 81 Hw t Manage UCMDB Licenses Using the JMX Cnsle 82 Hw t Access Supprt Using the JMX Cnsle 82 Hw t Cnfigure High Availability 87 Hw t Set Master Key fr Passwrd Encryptin n Data Flw Prbe 88 Hw t Set Master Keys 89 Hw t Cnfigure the UCMDB Mail Server 93 Hw t Change the Rt Cntext fr UCMDB Cmpnents 95 Hw t Custmize the Applicatin Title 96 Hw t Use the Database Tl 96 Hw t Deply Htfixes and Track Htfixes Applied n UCMDB Server 98 Hw t Cnfigure UCMDB Lg Levels 102 Hw t Retrieve UCMDB Server Lg Files 102 Hw t Cnfigure UCMDB t Save User Audit Lg t a Remte Machine 103 Hw t Cnfigure Micrsft IIS as Reverse Prxy fr UCMDB Server 105 Hw t Dwnlad a Zip File f Lg Files and Thread Dumps 105 Hw t Enable Validatin f the Hst Header f a Request 106 Hw t Retrieve UCMDB Server Lgs fr a Specific Time Frame 107 Hw t Use the User Activity Lg 108 Hw t Limit the Number f Cncurrent Sessins fr System Accunts 109 HPE Universal CMDB (10.31) Page 75 f 300

76 Chapter 5: UCMDB Server Administratin Hw t Set Up a Standalne Slr Envirnment 110 Hw t Run Slr in a Different Prcess than UCMDB 111 Slr Aut Cmmit 113 Hw t Set UCMDB Server Time, Change Time Zne Setting, r Crrect System-induced Clck Drift 115 Hw t Disable Caching f Generated IDs fr CIs, Jbs, and URM Resurces 115 Hw t Increase the Java Heap Memry Used by the UCMDB UI Java Applet 116 Hw t Cnfigure Cnfiguratin Manager t Cnnect t UCMDB Server 118 Hw t View the KPI Dashbard 119 Hw t Enable License Usage Tracking 125 Hw t Use the External JAR Cnfiguratin File 126 UCMDB Services 126 UCMDB Server Prts 130 UCMDB Integratin Service Prts 131 UCMDB Lg Files 132 Lg Severity Levels 146 Lg Cnfiguratin Dialg Bx 147 Enhanced File Uplad Mechanism 148 Trubleshting and Limitatins UCMDB Server Administratin 148 Basic Administratin Tasks This sectin prvides a checklist fr basic administratin and cnfiguratin tasks. Yu use this checklist t review the basic administratin tasks required t set up the Universal CMDB system. 1. Set up Data Flw Management Licensed Universal Discvery users can run the discvery prcess t identify IT resurces in the netwrk infrastructure. Fr details, see the HPE Universal CMDB Data Flw Management Guide. HPE Universal CMDB (10.31) Page 76 f 300

77 Chapter 5: UCMDB Server Administratin When setting up Data Flw Management, request the fllwing frm the system administratr: Operating system credentials Netwrk prtcl credentials Applicatin credentials 2. Set up users and rles Define users and rles and assign rles t users t grant permissins fr views, TQL queries and ther cmpnents. Fr details, see "User Permissins Wrkflw" n page 222 fr a single tenant envirnment and "Multi-Tenancy Wrkflw" n page 236 fr a multi-tenancy envirnment. 3. Cnfigure recipients f scheduled reprts, including methd f delivery Fr details, see "Reprts" in the HPE Universal CMDB Mdeling Guide. 4. Manually build yur IT universe mdel by defining cnfiguratin items (CIs) and CI relatinships in the mdel Divide the mdel int views that represent lgical subsets f the verall mdel. Add CIs based n discvered netwrk resurces r manually define infrastructure cmpnents. Fr details, see: "IT Universe Manager" in the HPE Universal CMDB Mdeling Guide "Mdeling Studi" in the HPE Universal CMDB Mdeling Guide Hw t Enable HTTP Cmmunicatin fr UCMDB Server Starting frm versin 10.30, by default the HTTPS prtcl is enabled fr UCMDB server, with the HTTP prtcl being disabled. Hwever, yu can enable HTTP cmmunicatin fr UCMDB server when necessary. T d s, 1. Open the c:\hp\ucmdb\ucmdbserver\cnf\settings.verride.prperties file using a text editr. 2. Add the fllwing line int the file: HPE Universal CMDB (10.31) Page 77 f 300

78 Chapter 5: UCMDB Server Administratin jetty.cnnectins.http.enabled=true 3. Save the file. 4. Restart the UCMDB server. 5. In the Web brwser, enter the URL f the HPE Universal CMDB Server with HTTP prtcl and prt 8080, fr example: name r IP address>.<dmain name>:8080 where <server name r IP address>.<dmain name> represents the fully qualified dmain name (FQDN) f the HPE Universal CMDB Server. Hw t Access the JMX Cnsle Many UCMDB actins can be perfrmed frm the JMX cnsle. UCMDB JMX Cnsle 1. On the UCMDB server, launch the Web brwser and enter the fllwing address: Nte: Starting frm versin 10.30, access t the JMX cnsle is restricted t lcalhst nly. If yu need t access the JMX cnsle remtely, see "Hw t Enable Remte Access t the JMX Cnsle" in the HPE Universal CMDB Administratin Guide. 2. Enter the JMX cnsle authenticatin credentials (Lgin name = sysadmin). The UCMDB JMX Quick Search page pens. There are three ways t access a JMX peratin frm the JMX hme page. Use the JMX quick search The JMX quick search feature prvides the ability t: Search fr a service. This is useful when yu knw that an peratin is in a certain service categry, but yu d nt knw the name f the peratin. Search fr a JMX peratin based n a keywrd Keywrds can be an peratin name, the descriptin f the peratin, r even the parameters used by the peratin. HPE Universal CMDB (10.31) Page 78 f 300

79 Chapter 5: UCMDB Server Administratin When typing, a suggestin list is displayed, prviding links t quickly access suggested methds. Search and access a UCMDB server lg frm the JMX cnsle Typing the wrd lg: in the search text displays a suggestin list with all the lgs that cntain the search wrd. Clicking ne f the suggested lgs redirects t a new page displaying the full cntent f the lg. Use the UCMDB JMX link D the fllwing: i. Click the UCMDB JMX link t pen the cnsle. ii. iii. Lcate the required service and click the link t pen the peratins page. Select the required peratin. Use the JMX Operatins Index link D the fllwing: i. Click the UCMDB JMX Operatins Index link t pen the cnsle peratin index. ii. G directly t the required methd and select it. Nte: It is recmmended t change the JMX passwrd. Fr details, see "Change the JMX Cnsle Passwrd" n the next page. Data Flw Prbe JMX Cnsle 1. On the prbe machine, launch the Web brwser and enter the fllwing address: Nte: Starting with versin 10.31, the HTTPS prt 8453 is enabled by default fr the Prbe JMX cnsle. Fr mre infrmatin, see "Using HTTPS Prt 8453 as Default fr Data Flw Prbe". In FIPS mde, yu can nly lg in t Data Flw Prbe JMX Cnsle using Internet Explrer with SSL 3.0 enabled. Firefx is nt supprted. 2. Enter the JMX cnsle authenticatin credentials (default username sysadmin): HPE Universal CMDB (10.31) Page 79 f 300

80 Chapter 5: UCMDB Server Administratin The Data Flw Prbe JMX Quick Search page pens. T search fr a JMX methd, enter a methd name r part f a methd name in the search bx. The search results display all methds cntaining the search phrase. 3. Click the Data Flw Prbe JMX link t pen the cnsle. Lcate the required service and click the link t pen the peratins page. Select the required peratin. 4. Click the Data Flw Prbe Operatins Index link t pen the cnsle peratin index. G directly t the required methd and select it. Nte: It is recmmended t change the JMX passwrd. Fr details, see "Change the JMX Cnsle Passwrd" belw. Change the JMX Cnsle Passwrd 1. Lg in t UCMDB with an administratr accunt and g t Security > Users and Grups. 2. Select the user fr the JMX Cnsle lgin (by default, sysadmin) and click the Reset Passwrd buttn. 3. In the Reset Passwrd dialg bx, enter the new passwrd and cnfirm it. Click OK. Nte: The default passwrd plicy requires the passwrd t include at least ne f each f the fur fllwing types f characters: Uppercase alphabetic characters Lwercase alphabetic characters Numeric characters Symbl characters,\:/. _?&%=+-[]() It als requires the passwrd t adhere t the minimum length, which is set by the Passwrd minimum length infrastructure setting. 4. Lg ut f UCMDB and lg in t the JMX Cnsle using the new passwrd. Cnfiguratin Manager JMX Cnsle There is a separate JMX cnsle fr Cnfiguratin Manager. HPE Universal CMDB (10.31) Page 80 f 300

81 Chapter 5: UCMDB Server Administratin On the Cnfiguratin Manager server, enter the fllwing address: name>:<applicatin_prt>/cnc/jmx-cnsle. The prt is the prt cnfigured during the installatin f Cnfiguratin Manager. Fr details, see the interactive HPE Universal CMDB Deplyment Guide. Fr details n accessing the Cnfiguratin Manager JMX Cnsle, see "Cnfiguratin Manager JMX Methds" in the HPE Universal CMDB JMX Reference Guide. Hw t Enable Remte Access t the JMX Cnsle Starting frm versin 10.30, the JMX cnsle is secured by restricting access t it t server lcalhst nly. Als, the JMX Cnsle is n lnger accessible thrugh HTTP prtcl, even if it is specifically reenabled. Administratrs attempting t access the JMX cnsle frm a remte machine may encunter all remte access attempts being redirected with n errr. The fllwing message will be shwn: Please wait, yu will be redirected in a mment. Hwever, yu can still enable remte access t JMX cnsle when necessary. T enable remte access t the JMX cnsle, Nte: This cnfiguratin affects bth the UCMDB server JMX cnsle and the prbe JMX cnsle. 1. On the UCMDB server, launch the Web brwser and enter the fllwing address: Yu may have t lg in with a user name and passwrd. 2. Lcate UCMDB:service=Settings Services and click the link t jump t the Operatins table. 3. Lcate the setglbalsettingvalue peratin. 4. Prvide the fllwing parameter values: name: restrict.jmx.t.lcalhst value: false Nte: Starting frm UCMDB versin 10.30, the default value is true, which disables remte access t the JMX cnsle, yu can nly access the JMX cnsle frm lcalhst. HPE Universal CMDB (10.31) Page 81 f 300

82 Chapter 5: UCMDB Server Administratin 5. Click Invke. 6. Restart the UCMDB server. The change takes effect and affects bth the UCMDB server JMX cnsle and the prbe JMX cnsle. Hw t Manage UCMDB Licenses Using the JMX Cnsle Yu can manage the prduct licenses frm the JMX Cnsle. This task describes hw t install a license. 1. On the UCMDB server, launch the Web brwser and enter the fllwing address: Yu may have t lg in with a user name and passwrd. 2. Click UCMDB:service=Licensing Services t pen the JMX MBEAN View page. 3. Lcate the addlicense methd. 4. Enter yur custmer ID and the license key. 5. Click Invke. There are additinal JMX methds available n the same page fr the fllwing functins: Installing a license frm a file Displaying all active licenses Displaying all licenses (including expired licenses) Displaying a summary f active licenses Remving all licenses Hw t Access Supprt Using the JMX Cnsle Universal CMDB prvides Supprtability JMX methds t help HPE Sftware Supprt diagnse prblems in yur system. The methds use handlers fr each categry, which gather infrmatin relevant t that categry frm yur system. When yu run a handler fr a categry, it dwnlads a zip HPE Universal CMDB (10.31) Page 82 f 300

83 Chapter 5: UCMDB Server Administratin file f the infrmatin gathered fr that categry. Generally, HPE Sftware Supprt runs the Supprtability methds t help prvide a slutin fr the issue raised. T access the Supprtability methds: 1. On the UCMDB server, launch the Web brwser and enter the fllwing address: Yu may have t lg in with a user name and passwrd. 2. Click UCMDB:service=Supprtability Services t pen the JMX MBEAN View page. 3. The listsupprtcategries methd displays all the supprt categries: T run all the handlers, invke the runsupprthandlersfrallcategries methd. T run specific handlers, invke the selectandrunsupprthandlers methd and select the handlers yu want t run. Alternatively, yu can run specific handlers using the runsupprthandlersfrspecificcategries methd. In the categries field, enter all the required handlers separated by cmmas, and click Invke. Supprtability Handlers The fllwing handlers are available: Basic. Hardware. Recrds all the hardware infrmatin abut the target physical r virtual machine in the Envirnment.prperties file. TQL. Recrds the fllwing data in the TQL.prperties file: Number f TQL queries Number f active TQL queries Number f active persistent TQL queries Number f nn-active TQL queries It als creates the Failed TQLs.txt file, cntaining the list f failed active TQL queries View. Recrds the fllwing data in the VIEW.prperties file: Number f views Number f views with a hierarchy definitin HPE Universal CMDB (10.31) Page 83 f 300

84 Chapter 5: UCMDB Server Administratin Number f views with a rule based hierarchy definitin Number f template based views Number f perspective based views Number f templates Number f perspectives Number f views f unknwn type (this value shuld always be 0) ViewArchive. Recrds the fllwing data in the ViewArchive.prperties file: Ttal number f archives Ttal number f views with archives Snapshts. Recrds the fllwing data in the Snapshts.prperties file: Ttal number f snapshts Mdeling. Recrds the fllwing data in the Mdeling.prperties file: Number f business CIs Number f mdels with cntent (mdels cntaining CIs) Number f pattern based mdels Number f instance based mdels Enrichment. Recrds the fllwing data in the Enrichment.prperties file: Number f Enrichment rules Number f all active Enrichment rules Number f nn-active Enrichment rules Number f Enrichment business views Number f all active Enrichment business views Number f nn-active Enrichment business views High Availability. Gathers the High Availability infrmatin frm all f the servers in the cluster: The High Availability cluster infrmatin is recrded in HA.prperties: Is_ha_enabled Cluster name (if high availability is enabled) HPE Universal CMDB (10.31) Page 84 f 300

85 Chapter 5: UCMDB Server Administratin Cluster ndes number (if high availability is enabled) Cluster ndes names (if high availability is enabled) The values fr the High Availability settings (starting with ha.) are recrded in HA settings.prperties Dmains. Gathers IP range infrmatin and recrds in the DmainsCnfiguratin Custmer <CustmerID>.xml file. Management Znes. Gathers rank, name, range definitin, discvery activities, activity jbs, and scheduling infrmatin fr management znes. Recrds this infrmatin in the MngZnesCnfiguratin Custmer <CustmerID>.xml file. URM Cunters. Recrds each f the registered URM types and the number f instances f each ne in the Basic URM Cunters.prperties file. Settings. Recrds the infrastructure settings and their values fr this custmer in the Settings Custmer <custmerid>.prperties file. Changed Settings. Recrds the changed infrastructure settings and their values fr this custmer in the Changed_Settings_Custmer <custmerid>.prperties file. Memry and Thread Cunt Inf. Recrds the UCMDB memry usage and thread cunt in the MemryAndThreadInf.html file. The infrmatin is displayed in clr: green, range, and red. If the clr is nt green, it requires attentin. Nte: LDAP authenticatin can generate many idle threads. Until these threads are clsed, it can temprarily lead t a high thread number which may cause perfrmance issues. Authrizatin. Recrds all the rles, users, user grups and rle assignments in the Authrizatin.prperties file. In a multi-tenancy envirnment, it recrds the tenant assciatin f each rle assignment. Basic Histry. Recrds the last date that the baseline prcess ran fr each CI type in the Basic Histry.prperties file. Histry. Recrds the number f histry events in the current histry table fr each CI type in the Histry.prperties file (nly fr CI types with histry events) Class Mdel. Recrds the class mdel as an XML file, Class Mdel.xml. In a multi-custmer envirnment, it recrds the number f different class mdels and their differences at the SDK level in the Class Mdel.prperties file. (In a single-custmer envirnment, this file cntains nly the infrmatin fr the single custmer.) Mdel Update. Recrds the fllwing data in the Basic Mdel Update.prperties file: HPE Universal CMDB (10.31) Page 85 f 300

86 Chapter 5: UCMDB Server Administratin Number f CIs per CI type (nly fr CIs with instances) Number f CIs cnnected t a Nde CI type r ne f its descendants Recnciliatin. Recrds data prcessing statistics read frm the cmdb.recnciliatin.lg file. It recrds the data in Excel frmat, in the DiscveryPrcessingStatistics.xls file. Data that might require attentin is highlighted in yellw and red. These threshlds are selected based n data cllected fr UCMDB versin 10.xx medium and large deplyments. The fllwing Excel sheets are created: dailyrates. Recrds daily statistics. The fllwing items are explained: Ttal Mdel time. Time needed t insert, update, r delete CIs t DB. A higher value might shw a DB slwness and require DBA invlvement. Ttal Identify time. Time required in building TQL queries, calculating TQL queries, matching between bulk and what was brught with TQL queries frm the UCMDB server. Ttal DataIN time. Time required fr merge peratins and recursive merge peratins. Daily Usage(% frm 24h). Amunt f time in a day the server is busy with data in prcessing. If this field is highlighted in yellw r red, the server might be verladed r there is a perfrmance slwness. Jbs Thrughput Rates Detailed. Data recrded per discvery/integratin jb frm the time the data is analysed. (First timestamp recrded in the lgs.) dailyratesperjb. Data recrded per discvery/integratin jb frm the time the data is analyzed but breakdwn per day. dailyratesperdatasurce. Data recrded per surce type and display by day. FailedBulksInf. Number f bulks that failed t be recrded by the discvery jb. It shws the number f bulks that failed and the time spent. At the end a summary is made fr all failed bulks. RemveByIDStats. Recrds data fr the CIs that are marked by the prbe as candidates fr deletin r CIs t be deleted. dailyratesperprbe. Recrds data per day fr each prbe that reprts data. Als it fetches all data that are nt created thrugh prbe as 'Nt thrugh Prbe'. Jbs Thrughput Rates Per Prbe. Recrds data reprted by every prbe frm the time the data is analyzed. (First timestamp recrded in the lgs.) General Inf. Shws the timeframe analyzed and recrded in the Excel file. Als recrds time spent fr successful and failed prcessed bulks. Number f data in bulks ignred frm lg file shws the number f bulks that were ignred. Pssible reasns are that data was nt HPE Universal CMDB (10.31) Page 86 f 300

87 Chapter 5: UCMDB Server Administratin prperly read r that the recnciliatin bulk was nt lgged prperly in the lg (every bulk must have tw lines: entry line and summary line lgged in cnsecutive rws in the lg file). Nte: The data is read frm the cmdb.recnciliatin.lg file based n regex. If the lg4j layut is changed fr the cmdb.recnciliatin.lg file, the data cannt be parsed. A jb might shw a perfrmance degradatin if the ttal time is higher than 600 secnds. Data In. Recrds actual deletin perid and deletin candidate perid infrmatin f the rt CI type that was verwritten by the settings fr child CI types in the Data In.prperties file. It als checks fr incnsistency in the database (bjects r links that exist in the rt CIT's table but nt in the subtype s table r the ther way arund). The incnsistent bjects are recrded in the incnsistencyinmdel.txt file and the incnsistent links are recrded in the incnsistencylinks.txt file. Hw t Cnfigure High Availability The fllwing infrastructure settings can be cnfigured fr a high availability envirnment. Infrastructure Setting Descriptin Value ha.tp.prt Enables yu t change the TCP prt. Default: 7800 ha.prts.range ha.writer.suggestin.perid.threshld Enables yu t change number f TCP prt that shuld be defined fr cnnectin. If ha.prts.range=0, and the prt defined in ha.tp.prt is ccupied, the cnnectin will fail. In the JMX Cnsle, yu can invke the High Availability Services > suggestnewwriterserver methd where yu can suggest which server (serverid) shuld replace the Writer server. This parameter enables yu define hw lng the server shuld keep trying t select the suggested server. After this threshld has be reached, the suggestin is Default: 0 (n range) Default: 240 secs HPE Universal CMDB (10.31) Page 87 f 300

88 Chapter 5: UCMDB Server Administratin Infrastructure Setting Descriptin Value canceled. ha.writer.inactivity.perid.threshld Defines hw lng t wait after the Writer server stps respnding, befre selecting a new Writer server. Default: 120 secs Nte: Changing this time als affects the time it takes t select the new Writer after restarting the previus Writer server. ha.lad.balancer.frce.clse.cnnectin When this setting is set t true, the UCMDB SDK clients add a Cnnectin:clse header t each authenticatin request and class dwnlad request sent t the server. This way the lad balancer will think this is a first request in a cnnectin and add the sessin ckie t the respnse. If the lad balancer yu are using already adds a sessin ckie t every request sent, then this parameter shuld be set t false t prevent a decline in system perfrmance. Default: false Hw t Set Master Key fr Passwrd Encryptin n Data Flw Prbe This sectin explains hw t set a master key fr passwrd encryptin n Data Flw Prbe. This key is updated with a new pass. The updated pass is stred in the DataFlwPrbe.prperties file. T set the master key fr passwrd encryptin n Data Flw Prbe, 1. Access the Data Flw Prbe JMX cnsle. On the prbe machine, launch a Web brwser and enter the fllwing address: Yu may have t lg in with a user name and passwrd. HPE Universal CMDB (10.31) Page 88 f 300

89 Chapter 5: UCMDB Server Administratin Nte: If yu have nt created a user, use the default user name sysadmin t lg in. 2. Lcate the type=mainprbe service and click the link t pen the Operatins page. 3. Lcate the changemasterkey peratin. 4. In the pass field, enter the new pass t change master key. 5. In the repass field, enter the new pass again t duble cnfirm. 6. Click Invke. The result f the invcatin is a message like the fllwing: The key is changed successfully. Nte: Fr Data Flw Prbes installed in separate mde, yu need t change the master key n bth prbe gateway and prbe manager. Hw t Set Master Keys Yu can use the JMX cnsle t change the master key that is used t encrypt all UCMDB keys. Change the master key fr a cluster This methd assumes that yur UCMDB envirnment is deplyed in a high-availability setup. Cautin: This methd invlves a restart f the entire cluster, s plan accrdingly. It is recmmended t change the master key f the cluster when there is little r n lad n the servers. Fr example, yu shuld avid using this methd during data-in peratins. D nt change any settings in the time perid between changing the master key and restarting the server. Nt fllwing this instructin may result in a failure t start the server. Machines that are nt up r that will be added later t the cluster will need t be cnfigured manually. Until they are cnfigured, at mst they can run as reader machines; trying t run them as writer machines will fail. 1. Back up the c:\hp\ucmdb\ucmdbserver\cnf\cmdb.cnf file and the values fr the fllwing settings: HPE Universal CMDB (10.31) Page 89 f 300

90 Chapter 5: UCMDB Server Administratin ha.cluster.authenticatin.keystre.passwrd ha.cluster.authenticatin.shared.secret ha.cluster.message.encryptin.keystre.passwrd ssl.server.keystre.passwrd ssl.server.truststre.passwrd 2. Make sure all the servers in the cluster are up and running. 3. On the writer machine, launch the Web brwser and enter the fllwing address t lg in t the JMX cnsle: Nte: If a lad balancer is present, yu must bypass it and nt lg n t the writer machine thrugh a lad balancer. 4. D ne f the fllwing: Search fr changemasterkeyfrcluster. Click UCMDB:service=Security Services > changemasterkeyfrcluster. 5. Enter and cnfirm the master key, and click Invke. The master key will be changed first n the writer machine and then n all reader machines. Nte: The master key must be exactly 32 characters and include at least ne f each f the fllwing fur types f characters: Uppercase alphabetic characters Lwercase alphabetic characters Numeric characters At least ne f these special characters:,\:/._?&%=+-[]() 6. Restart all the machines in the cluster. Yu can use the JMX methd High Availability Services > restartcluster t d this. Nte: Restart the cluster immediately after changing the master key. If yu d nt, future database cnnectins may fail. Change the master key fr a new machine in a cluster If at least ne f the fllwing settings was changed, use Methd A; therwise, use Methd B: HPE Universal CMDB (10.31) Page 90 f 300

91 Chapter 5: UCMDB Server Administratin ha.cluster.authenticatin.keystre.passwrd ha.cluster.authenticatin.shared.secret ha.cluster.message.encryptin.keystre.passwrd ssl.server.keystre.passwrd ssl.server.truststre.passwrd Methd A This methd assumes that yu already have prperly cnfigured a master key fr the writer machine that is up and running in the cluster. If nt, fllw the instructins in "Change the master key fr a cluster" n page Cpy the c:\hp\ucmdb\ucmdbserver\bin\wrapper.cnf file frm the writer machine t the same lcatin n the new (reader) machine. 2. Restart the server. Methd B 1. Back up the c:\hp\ucmdb\ucmdbserver\cnf\cmdb.cnf file. 2. On the writer machine, launch the Web brwser and enter the fllwing address t lg in t the JMX cnsle: 3. D ne f the fllwing: Search fr changemasterkey. Click UCMDB:service=Security Services > changemasterkey. 4. Enter and cnfirm the master key, and click Invke. Nte: The master key must be exactly 32 characters and include at least ne f each f the fllwing fur types f characters: Uppercase alphabetic characters Lwercase alphabetic characters Numeric characters At least ne f these special characters:,\:/._?&%=+-[]() 5. Restart the machine. HPE Universal CMDB (10.31) Page 91 f 300

92 Chapter 5: UCMDB Server Administratin Nte: Restart the cluster immediately after changing the master key. If yu d nt, future database cnnectins may fail. Revert the master key fr a cluster t its default value This prcedure resets the master key fr an entire cluster. 1. Make sure all the servers in the cluster are up and running. 2. On the writer machine, launch the Web brwser and enter the fllwing address t lg in t the JMX cnsle: Nte: If a lad balancer is present, yu must bypass it and nt lg n t the writer machine thrugh a lad balancer. 3. D ne f the fllwing: Search fr restremasterkeyfrcluster. Click UCMDB:service=Security Services > restremasterkeyfrcluster. 4. Click Invke. The master key will be changed first n the writer machine and then n all reader machines. 5. Restart all the machines in the cluster. Yu can use the JMX methd High Availability Services > restartcluster t d this. Nte: Restart the cluster immediately after changing the master key. If yu d nt, future database cnnectins may fail. Revert the master key fr a machine that was dwn when master key was reverted fr whle cluster 1. Back up the c:\hp\ucmdb\ucmdbserver\cnf\cmdb.cnf file. 2. On the writer machine, launch the Web brwser and enter the fllwing address t lg in t the JMX cnsle: 3. D ne f the fllwing: Search fr restremasterkey. Click UCMDB:service=Security Services > restremasterkey. HPE Universal CMDB (10.31) Page 92 f 300

93 Chapter 5: UCMDB Server Administratin 4. Click Invke. 5. Restart the machine. Nte: Restart the cluster immediately after changing the master key. If yu d nt, future database cnnectins may fail. Hw t Cnfigure the UCMDB Mail Server 1. Cnfigure UCMDB mail server a. In UCMDB, g t Administratin > Infrastructure Settings > Mail Settings. b. Cnfigure mail settings as described in the table belw: Mail Setting Activate TLS/SSL cnnectin SMTP server Descriptin If SMTP server requires secure cnnectin via TLS/SSL then the value shuld be True, and make sure yu prceed t 2. Cnfigure UCMDB client t cnfigure cmmunicatin prtcl. Else if SMTP server accepts nn-secure cnnectin, the value shuld be changed t False. Enter the address f the SMTP server. SMTP server prt Edit the SMTP server prt. The default value is 25. The username f SMTP server The passwrd f SMTP server sender Sender editability Enter the user name f the primary SMTP server. If n authenticatin is required, leave this filed empty. Enter the passwrd f the primary SMTP server. If n authenticatin is required, leave this filed empty. Enter the name t appear in reprts that HPE Universal CMDB sends. Setting this value t True enables users t change the sender name inside the frm that sends mail. Otherwise, leave its value as False. c. As a backup fr the main SMTP server, yu can prvide infrmatin abut an alternative server. Cnfigure the fllwing settings: HPE Universal CMDB (10.31) Page 93 f 300

94 Chapter 5: UCMDB Server Administratin Mail Setting Alternate SMTP server Alternate SMTP server prt Alternate SMTP server username Alternate SMTP server passwrd Descriptin Enter the address f the alternate SMTP server. Enter the alternate SMTP server prt. Enter the user name f the alternate SMTP server. If n authenticatin is required, leave this filed empty. Enter the passwrd f the alternate SMTP server. If n authenticatin is required, leave this filed empty. Nte: It is strngly recmmended t set bth the SMTP server and Alternate SMTP server. In case the SMTP server is nt available, the alternative SMTP server will be used by the UCMDB server when sending s. 2. Cnfigure UCMDB client Nte: This step is required nly when Activate TLS/SSL cnnectin is set t True. After cnfiguring the mail server with a certificate, t benefit frm secure cmmunicatin and secure authenticatin ptin, yu must transfer the certificate t UCMDB server truststres. a. Retrieve UCMDB JRE path. Example: C:\hp\UCMDB\UCMDBServer\bin\jre b. Retrieve yur certificate path. Example: C:\Users\Administratr.SMTP\Desktp\certs\Keypublic.pem (the file extensin culd be anything, nt just pem) c. Retrieve UCMDB server truststre path. Examples: C:\hp\UCMDB\UCMDBServer\cnf\security\server.truststre, r C:\hp\UCMDB\UCMDBServer\cnf\security\server-fips.truststre (fr FIPS mde) d. Retrieve UCMDB JRE truststre path. Example: C:\hp\UCMDB\UCMDBServer\bin\jre\lib\security\cacerts e. Navigate t the C:\hp\UCMDB\UCMDBServer\bin\jre\bin flder, and pen the cmmand HPE Universal CMDB (10.31) Page 94 f 300

95 Chapter 5: UCMDB Server Administratin prmpt. f. Run the fllwing cmmands using keytl t imprt the certificate t UCMDB server truststre and UCMDB JRE truststre: Nte: Default truststre passwrds are used in the fllwing cmmands : changeit and hppass. If yu cnfigured a specific passwrd fr yur truststre, just replace hppass r changeit with yur passwrd. Als, paths prvided in the examples abve are used. Make sure yu replace them with yur specific paths. Cmmand fr imprting the certificate t UCMDB JRE truststre: keytl -imprt -file "C:\Users\Administratr.SMTP\Desktp\certs\Keypublic.pem" -keystre "C:\hp\UCMDB\UCMDBServer\bin\jre\lib\security\cacerts" -alias "give certificate a name" -strepass changeit Cmmand fr imprting the certificate t UCMDB server truststre: Fr nn-fips mde: keytl -imprt -file "C:\Users\Administratr.SMTP\Desktp\certs\Keypublic.pem" -keystre "C:\hp\UCMDB\UCMDBServer\cnf\security\server.truststre" -alias "give certificate a name" -strepass hppass Fr FIPS mde: keytl -imprt -fle "C:\Users\Administratr.SMTP\Desktp\certs\Keypublic.pem" -keystre "C:\hp\UCMDB\UCMDBServer\cnf\security\server-fips.truststre" -alias "give certificate a name" -stretype PKCS12 -prvidername JsageJCE - strepass hppass Hw t Change the Rt Cntext fr UCMDB Cmpnents The default rt cntext fr all HPE Universal CMDB cmpnents is /. This rt cntext can be cnfigured in the Infrastructure Settings Manager. T change the rt cntext: 1. G t Administratin > Infrastructure Settings Manager and select the Rt cntext setting under General Settings. HPE Universal CMDB (10.31) Page 95 f 300

96 Chapter 5: UCMDB Server Administratin 2. Edit the setting and save yur changes. 3. Restart HPE Universal CMDB. One applicatin f this feature is the ability t access multiple UCMDB servers using ne reverse prxy server. Each UCMDB server can be cnfigured with its wn rt cntext. Cautin: After changing the rt cntext frm its default value, all UCMDB cmpnents are nly available using the new rt cntext. Fr example, if the new rt cntext is /ucmdb1, the user interface will be accessible frm the fllwing url: name r IP address>.<dmain name>:8443/ucmdb1/ucmdb-ui. Fr Cnfiguratin Manager users: If yu change the rt cntext, yu must update the UCMDB access URL field in Cnfiguratin Manager accrdingly (Administratin > Settings > Integratins > UCMDB Fundatin). Hw t Custmize the Applicatin Title Yu can custmize the title that appears n the UCMDB hme page and the lgin page. This can help yu t easily distinguish between prductin and testing envirnments. T custmize the applicatin title, fllw these steps: 1. In Infrastructure Settings Manager, lcate the UCMDB Custm Title setting. 2. In the Value field, enter the text t append t the applicatin title. Nte: The maximum number f characters that are displayed in the custmized title is 30. If yu enter mre than 30 characters in the Value field, nly the first 30, fllwed by..., appear in the custmized title. 3. Save yur changes. 4. When yu next access UCMDB, the hme page and lgin page display the custmized applicatin title after the UCMDB prduct versin. Hw t Use the Database Tl Universal CMDB prvides a tl fr mdifying the database directly withut accessing the user interface. Cautin: D nt use the Database tl t mdify the database unless instructed t d s by HPE HPE Universal CMDB (10.31) Page 96 f 300

97 Chapter 5: UCMDB Server Administratin Sftware Supprt. T run the Database tl, fllw these steps: 1. Make sure that the UCMDB Server is dwn. 2. Run the fllwing batch file frm the cmmand line: C:\hp\UCMDB\UCMDBServer\tls\dbscripts\newDbTl.bat 3. At the prmpt, run the required cmmand. The Database tl perates in the fllwing mdes: Cnsistency Mde Deletin Mde Preview Mde Cnsistency Mde The Cnsistency mde f the tl enables yu t check the cnsistency f the database. Run the cmmand newdbtl.bat cnsistency. Yu can add --shwsql at the end f the cmmand t display the SQL cmmands that are running. Deletin Mde The Deletin mde f the tl enables yu t delete CIs and relatinships frm the database via ne f the fllwing methds: Running the Aging mechanism. Use the cmmand newdbtl.bat aging.when yu run the Aging mechanism, CIs and relatinships that are candidates fr deletin are remved. Fr details, see "The Aging Mechanism Overview" n page 209. Deleting selected CIs by type. Yu can delete all CIs f a specific type by running the cmmand newdbtl.bat type type_1, type_2 where type_1 and type_2 represent the CI types t delete. Deleting selected CIs by SQL query. Yu can delete the CIs selected by running an SQL query. Run the cmmand newdbtl.bat sql <query_name> where <query_name> is the name f the SQL query yu have defined. The fllwing is an example f an SQL query that returns all nde CIs with a display label starting with vm: HPE Universal CMDB (10.31) Page 97 f 300

98 Chapter 5: UCMDB Server Administratin select CMDB_ID frm cdm_nde_1 where a_display_label like 'VM%' Nte: The SQL query must return a single clumn which is the CMDB_ID. Preview Mde The Preview mde f the tl enables yu t preview the changes that the cnsistency mde will intrduce befre executing them. Run the cmmand newdbtl.bat cnsistency --preview. Hw t Deply Htfixes and Track Htfixes Applied n UCMDB Server Overview Starting frm versin 10.30, packaging f htfix files is imprved t enable easy deplyment and management. The newly intrduced JMX methd shwallbinariesapplied allws yu t easily view and track all infrmatin abut the htfixes yu deplyed, and the enhanced JMX methd viewsysteminfrmatin allws yu t view IDs f htfixes applied in additin t ther system infrmatin. When yu deply htfixes, yu are actually deplying each f them separately in a different flder under the classes flder. Path examples fr different htfix types are as fllws: Server side htfix type Server backend UI - Server UI - Applet Path frmat <UCMDB_Install_Dir>/classes/HF_QCCR1HXXXXX/cm/hp/ucmdb/ <UCMDB_Install_Dir>/deply/ucmdb-ui/WEB-INF/classes/HF_ QCCR1HXXXXX/cm/hp <UCMDB_Install_Dir>/deply/ucmdb-ui/static/appletPatches/YYYY_ MM_DD_QCCR1HXXXXX.jar The htfix flder name where the classes are laded fllws the frmat f HF_QCCR1H<ID>. If the htfix flder name des nt start with the HF_ prefix, the classes fr the htfix will nt be laded. The lgging binaries fllw this frmat: HF_LOGGING. Fr applet lgs, the lgging filename frmat is an exceptin, which fllws the frmat YYYY_MM_DD_ QCCR1H<id>. HPE Universal CMDB (10.31) Page 98 f 300

99 Chapter 5: UCMDB Server Administratin UI - Server and Server backend htfixes have the Readme file directly inside the htfix flder. Fr example, fr HF_QCCR1H101112, the readme file is lcated in the flder..\hf_ QCCR1H101112/Readme_QCCR1H txt, as shwn in the screensht belw. If it has a different name and/r placed in a different lcatin it will nt be read. Fr applet htfixes, the readme file will nt be read, because it is nt an executable. After deplyment, the htfixes are laded at server startup, and messages similar t the fllwing are added t the startup.lg file: Befre jetty starts: Lading extra classpath C:\HP\UCMDB\UCMDBServer1030\bin\..\ After the server is up: [Cntrller] - Htfixes Applied: QCCR1H12313 QCCR1H11244 QCCR1H23211 LOGGING QCCR1H QCCR1H QCCR1H Warning if there are duplicate files fr different htfixes: [Cntrller] - The server has binaries/htfixes applied which verlap. Cntact HPE engineers t make sure there is n incnsistency. Invke Jmx shwallbinariesapplied t check the classes Nte: Htfixes are laded at UCMDB server startup. If a new htfix is deplyed, it will nt be displayed until the UCMDB server restarts. Every htfix has a unique QCCR ID, which will be added t the htfix flder name after the HF_ prefix. The recmmended apprach fr htfix deplyment is manual deplyment. UCMDB administratrs shuld manually unzip the htfix files t the UCMDB server machine and deply the htfix files. Fr high availability (HA) deplyments, this shuld be dne n each UCMDB server. HPE Universal CMDB (10.31) Page 99 f 300

100 Chapter 5: UCMDB Server Administratin Anther apprach may be t use the cpyclassesfldertotherservers JMX methd. Depending n netwrk latency, this apprach can take lnger, als sme classes might be lst. When multiple htfixes are deplyed, class files frm htfixes will be laded in the sequential rder f QCCR IDs f the htfixes. Fr example, if htfixes HF_QCCR1H and HF_ QCCR1H are deplyed, the class files frm HF_QCCR1H will be laded first. This is imprtant t knw in the crner case when a class file is deplyed n the server side by tw htfixes. Hw t deply server backend and UI - Server htfixes 1. Stp the UCMDB server. 2. Extract classes.zip. 3. Cpy the classes flder f the zip int the fllwing directry, depending n the htfix type: Htfix type Server backend UI - Server Target flder <UCMDB_Install_Dir>/ <UCMDB_Install_Dir>/deply/ucmdb-ui/WEB-INF/ If there already exists a classes flder, back up the flder first, and then cpy the classes flder f the zip int the abve flder t replace the existing ne. After deplyment, the htfix path lks like the fllwing: Htfix type Server backend UI - Server Path example <UCMDB_Install_Dir>/classes/HF_QCCR1HXXXXX/cm/hp/ucmdb/ <UCMDB_Install_Dir>/deply/ucmdb-ui/WEB-INF/classes/HF_ QCCR1HXXXXX/cm/hp 4. Fr HA deplyments, repeat step 2 and step 3 n each UCMDB server. 5. Restart the UCMDB server(s). 6. Check server startup lg r invke JMX methd shwallbinariesapplied t make sure the binary/htfix was prperly deplyed. HPE Universal CMDB (10.31) Page 100 f 300

101 Chapter 5: UCMDB Server Administratin Hw t deply applet htfixes 1. Stp the UCMDB server. 2. Extract appletpatches.zip. 3. Cpy the appletpatches flder f the zip int the fllwing directry: <UCMDB_Install_ Dir>\deply\ucmdb-ui\static If there already exists an appletpatches flder, back up the flder first, and then cpy the appletpatches flder f the zip int the abve flder t replace the existing ne. After deplyment, the htfix path lks like the fllwing: <UCMDB_Install_Dir>/deply/ucmdb-ui/static/appletPatches/YYYY_MM_DD_ QCCR1HXXXXX.jar 4. Fr HA deplyments, repeat step 2 and step 3 n each UCMDB server. 5. Restart the UCMDB server(s). 6. Check server startup lg r invke JMX methd shwallbinariesapplied t make sure the binary/htfix was prperly deplyed. Hw t view and track htfixes deplyed n UCMDB Server T view and track htfixes deplyed n UCMDB server, 1. On the UCMDB server, launch the Web brwser and enter the fllwing address: 2. Enter the JMX cnsle authenticatin credentials (Lgin name = sysadmin). 3. Lcate the fllwing peratins in the UCMDB:service=Server Services categry: T view IDs f htfixes applied nly, lcate the viewsysteminfrmatin peratin. T view and track detailed infrmatin abut htfixes deplyed, lcate the shwallbinariesapplied peratin. 4. Click Invke. The result page f the viewsysteminfrmatin peratin displays the system infrmatin f the UCMDB server, including the IDs f htfixes deplyed n the server. This is als saved in the supprtability JMX general categry utput. The result page f the shwallbinariesapplied peratin displays detailed infrmatin abut the htfixes deplyed, including htfix type (server backend, UI server, r applet), readme file, HPE Universal CMDB (10.31) Page 101 f 300

102 Chapter 5: UCMDB Server Administratin if there're any verlapping files, and if there are any wrngly placed files. See the screensht belw fr an example. Hw t Cnfigure UCMDB Lg Levels This task describes hw t specify the lg level fr UCMDB lg files. 1. On the UCMDB server, launch the Web brwser and enter the fllwing address: Yu may have t lg in with a user name and passwrd. 2. Click UCMDB:service=Server Services t pen the JMX MBEAN View page. 3. Lcate the lggerslevels methd. 4. Click Invke. 5. Frm the list next t each lg file name fr which yu want t set the level, select the required lg level (OFF, FATAL, ERROR, WARN, INFO, DEBUG, TRACE, r ALL). 6. Click Update lggers. Hw t Retrieve UCMDB Server Lg Files This task describes hw t retrieve UCMDB Server lg files. If the UCMDB Server is peratinal a. Launch the Web brwser and enter the fllwing address: Yu may have t lg in with a user name and passwrd. (Default user name is sysadmin) b. Search and click UCMDB:service=Server Services t pen the JMX MBEAN View page. c. Click executelggrabber. HPE Universal CMDB (10.31) Page 102 f 300

103 Chapter 5: UCMDB Server Administratin d. Click Invke. e. Prvide the dwnladed zip package t HPE Custmer Supprt Service. If the UCMDB server is nt peratinal a. Execute the LgGrabber script: <UCMDB_Server_ Hme>/tls/lgGrabber/lgGrabber.bat b. Clear the cntent f the fllwing flder: <UCMDB_Server_Hme>/runtime/lg Make sure NOT t remve the lg flder itself. c. Restart the UCMDB Server. d. Allw sme time fr the prblem t reprduce. e. Execute the LgGrabber script again: <UCMDB_Server_ Hme>/tls/lgGrabber/lgGrabber.bat f. Cllect the mst recent LgGrabber archive first frm <UCMDB_Server_ Hme>/runtime/lgGrabber_xxx.zip and uplad it t the Supprt incident. g. Once the uplad cmpletes in step f, infrm Supprt and uplad the LgGrabber utput f Step a. Hw t Cnfigure UCMDB t Save User Audit Lg t a Remte Machine UCMDB may be cnfigured t save user audit lg n a different remte machine. The cmmunicatin with the remte machine is usually dne using TCP. On the remte machine, a ServerScket shuld be running that listens fr cnnectins n a specific prt. The prt shuld nt be blcked by the firewall. T start the ServerSket n the remte machine, run the fllwing cmmand: java -cp lg4j jar rg.apache.lg4j.net.simplescketserver 4712 lg4jserver.prperties where : 4712 is the listening prt. lg4jserver.prperties is the lg cnfiguratin file that yu shuld create and place n the Server machine. It will cntain all the infrmatin abut where t write the received lgs. Make sure HPE Universal CMDB (10.31) Page 103 f 300

104 Chapter 5: UCMDB Server Administratin yu fllw the lg4j cnfiguratin standards ( when yu create the file. Fr a sample file, see lg4jserver.prperties file example belw. lg4j jar is needed t start the ServerScket. It can be btained frm the <UCMDB_ Server_Hme>\lib directry. On the client machine (where UCMDB is installed), the desired lgs shuld be cnfigured in rder t cnnect t the ServerScket. T cnfigure the lg n the client machine, 1. Open the lg cnfiguratin file n the client machine. In the example belw, the lg file is recnciliatin.prperties frm the <UCMDB_Server_Hme>\cnf\lg directry. 2. Add the fllwing lines int the file: ####################################### ### cmdb.recnciliatin.appender ## ####################################### lg4j.appender.cmdb.recnciliatin.lg.appender=rg.apache.lg4j.net.scketa ppender lg4j.appender.cmdb.recnciliatin.lg.appender.layut=rg.apache.lg4j.patt ernlayut lg4j.appender.cmdb.recnciliatin.lg.appender.layut.cnversinpattern=${m sg.layut} lg4j.appender.cmdb.recnciliatin.lg.appender.prt=4712 lg4j.appender.cmdb.recnciliatin.lg.appender.remtehst=<ip address f the remte hst> 3. Restart UCMDB. lg4jserver.prperties file example Belw is an example f the file: lg4j.rtlgger=debug, stdut lg4j.appender.stdut=rg.apache.lg4j.cnsleappender lg4j.appender.stdut.target=system.ut lg4j.appender.stdut.layut=rg.apache.lg4j.patternlayut lg4j.appender.stdut.layut.cnversinpattern=%t %-5p %c{2} - %m%n lg4j.categry.cmdb.recnciliatin.lg=debug,cmdb.recnciliatin.lg.appender HPE Universal CMDB (10.31) Page 104 f 300

105 Chapter 5: UCMDB Server Administratin ####################################### ### cmdb.recnciliatin.appender ## ####################################### lg4j.appender.cmdb.recnciliatin.lg.appender=rg.apache.lg4j.fileappender lg4j.appender.cmdb.recnciliatin.lg.appender.file=cmdb.recnciliatin.lg lg4j.appender.cmdb.recnciliatin.lg.appender.layut=rg.apache.lg4j.patternl ayut lg4j.appender.cmdb.recnciliatin.lg.appender.layut.cnversinpattern=%t %-5p %c{2} - %m%n Hw t Cnfigure Micrsft IIS as Reverse Prxy fr UCMDB Server 1. Prerequisites: Befre dwnlading and installing ARR, make sure that yu have already installed Internet Infrmatin Services (IIS). 2. Install ARR frm the fllwing URL using the Micrsft Web Platfrm Installer: Once installed, the Server Farms item shuld be present in the Cnnectins tree inside the IIS Manager. 3. Right-click Server Farms and select Create Server Farm. Specify Server Farm name (make sure the Online checkbx is checked) and click Next. 4. Enter the address f the UCMDB brwser tgether with the prt n which the brwser can be accessed, and then click the Add buttn. (The prt can be entered in the Advanced settings.) 5. After IIS knws which is the server behind, it is necessary t create a simple URL rewriting rule. When prmpted fr that, select Yes. Hw t Dwnlad a Zip File f Lg Files and Thread Dumps Yu can prduce a zip file that includes all lgs and thread dumps. Yu create the file either thrugh a JMX peratin n the client machine, r by running a batch file n the UCMDB Server. Thread dumps are created peridically: Once a minute, a thread dump snapsht is taken and is saved t a new file in the C:\hp\UCMDB\UCMDBServer\runtime\lg\threadDumps flder. Thread dump HPE Universal CMDB (10.31) Page 105 f 300

106 Chapter 5: UCMDB Server Administratin files frm the last hur are kept. This flder als hlds the ad hc Server snapshts that are generated during the lggrabber executin. T generate the zip file frm the client machine: 1. Launch the Web brwser and enter the server address, as fllws: Server Hst Name r IP>:8443/jmx-cnsle. Yu may have t lg in with a user name and passwrd. 2. Under UCMDB, click UCMDB:service=Server services t pen the JMX MBEAN View page. 3. Lcate the executelggrabber peratin. 4. Click Invke. A Server snapsht file with the name LgGrabber_serverSnapsht_ <current date and time>.txt is created in the fllwing lcatin: C:\hp\UCMDB\UCMDBServer\runtime\lg\threadDumps. This is a thread dump that includes the threads f the Server framewrk nly. 5. In the File Dwnlad dialg bx, yu can pen the lggrabber_<current time>.zip file, r dwnlad it t the client machine. T generate the zip file frm the UCMDB Server: 1. Access the fllwing flder n the UCMDB Server: C:\hp\UCMDB\UCMDBServer\tls\lgGrabber\. 2. Run the lggrabber.bat file. The LgGrabber_<current time>.zip file is created in the fllwing lcatin: C:\hp\UCMDB\UCMDBServer\runtime. This is a thread dump that includes the threads f the Server framewrk nly. Hw t Enable Validatin f the Hst Header f a Request T enable validatin f hst header f a request based n a regular expressin, 1. Access the UCMDB server JMX cnsle: Launch a Web brwser and enter the fllwing address: machine name r IP address>:8443/jmx-cnsle. Yu may have t lg in with a user name and passwrd (default user name: sysadmin). HPE Universal CMDB (10.31) Page 106 f 300

107 Chapter 5: UCMDB Server Administratin 2. Lcate UCMDB:service=Settings Services and click the link t jump t the Operatins table. 3. Lcate the setglbalsettingvalue peratin. 4. T enable validatin f hst header f a request, prvide values fr the fllwing parameters fr the setglbalsettingvalue methd: name: security.filter.header.allwed.hst value: <enter a JAVA regex that matches a valid hst> Fr example, mymachine, will nly accepts a hst header that cntains the value mymachine. mymachine.* lcalhst, will accept mymachine.mydmain.cm, mymachine.subd1.dmain1.cm r any dmain starting with mymachine r lcalhst as hst. The default value f the security.filter.header.allwed.hst setting is.*. It affects URLs cntaining /ucmdb-ui/ nly. Fr example, 5. Click Invke. The setting takes effect immediately. 6. Restart the whle UCMDB cluster t ensure that the setting is picked up by all readers. Hw t Retrieve UCMDB Server Lgs fr a Specific Time Frame Yu can prduce a zip file cntaining all UCMDB server lgs fr a given time frame. This is intended fr supprt engineers r ther users wh need t btain lgs fr a specific time frame. T generate the zip file frm the client machine: 1. Launch the Web brwser and enter the server address, as fllws: Server Hst Name r IP>:8443/jmx-cnsle. Yu may have t lg in with a user name and passwrd. 2. Under UCMDB, click UCMDB:service=Server Services t pen the JMX MBEAN View page. 3. Lcate the executeserverlgparser peratin. 4. Enter the start time in the required frmat. HPE Universal CMDB (10.31) Page 107 f 300

108 Chapter 5: UCMDB Server Administratin 5. (Optinal) Enter an end time. If yu d nt prvide an end time, the current time that the JMX methd is invked is used. 6. Click Invke. When the prcess has finished, the file can be dwnladed frm the brwser. Limitatins The zip file is als lcated n the UCMDB server machine as the c:\hp\ucmdb\ucmdbserver\runtime\parsedlggrabber_<time>.zip file. Fr maintenance purpses, this file must be manually deleted. The flder c:\hp\ucmdb\ucmdbserver\runtime\lg\parsedlgs_<date> is als created and cntains the unzipped cntents. Fr maintenance purpses, this file must be manually deleted. In high availability UCMDB deplyments, this JMX methd is running against ne server nly. Only lgs frm the same date can be parsed. Hw t Use the User Activity Lg When trubleshting a prblem in yur system, anther useful tl is the User Activity lg. When activated, this lg recrds all the actins perfrmed n yur system, enabling HP Sftware Supprt t reprduce the prblem and trublesht it. T activate the User Activity lg, first verify that it is enabled: 1. On the UCMDB server, launch the Web brwser and enter the fllwing address: Yu may have t lg in with a user name and passwrd. 2. Click UCMDB:service=Settings Services t pen the JMX MBEAN View page. 3. Lcate the shwsettingsbycategry methd. 4. Enter General Settings as the categry name and click Invke. 5. Lcate the mam.web.user.activity.lg.enabled setting and verify that it is set t true. 6. If it is set t false, g back t the Settings Services page, and select the setsettingvalue methd. 7. Enter mam.web.user.activity.lg.enabled as the setting and true as the value and click Invke. Next, change the lg level t INFO: HPE Universal CMDB (10.31) Page 108 f 300

109 Chapter 5: UCMDB Server Administratin 1. In the JMX Cnsle, click UCMDB:service=Server Services 2. Lcate the lggerslevels methd and click Invke. 3. Lcate the cm.hp.ucmdb.uiserver.aspects lgger and select INFO frm the drp-dwn list. 4. Click Update lggers. The lg is nw activated. Perfrm the actins that led t the prblem. The User Activity lg autmatically recrds them. When yu are finished, disable the lg using the lggerslevels methd and selecting ERROR as the level fr the cm.hp.ucmdb.uiserver.aspects lgger. Hw t Limit the Number f Cncurrent Sessins fr System Accunts This security cntrl addresses certain U.S gvernment guidelines fr limiting the number f cncurrent sessins fr each accunt t a cnfigurable number f sessins. Nte: Yu must have administratr privileges t make this change. This change will have glbal impact n all user accunts. 1. Lcate the setting Frm the Navigatin menu, select Infrastructure Settings Manager r select Managers > Administratin > Infrastructure Settings Manager. In the Categries pane, click Security Settings. 2. Cnfigure the parameter Lcate the Maximum number f sessins allwed per user parameter and change the value in the Value clumn. Nte: The default is 0, which means that there is n limit t the number f cncurrent sessins an accunt can have while lgging n frm different cmputers. HPE Universal CMDB (10.31) Page 109 f 300

110 Chapter 5: UCMDB Server Administratin Hw t Set Up a Standalne Slr Envirnment 1. Dwnlad Apache Slr r a later versin, and then extract the package t a lcal flder. 2. Create and cnfigure the Slr hme. T d this, fllw these steps: a. Create a directry that will be the Slr hme. b. Cpy the slr.xml file under the <UCMDB_Server_Hme>\search\slr_dp flder t the Slr hme. c. Create the fllwing flder structure in the Slr hme: cnfigsets\ucmdb_cnfigs\cnf d. Cpy the fllwing files frm the <UCMDB_Server_Hme>\search\slr_ dp\cnfigsets\ucmdb_cnfigs\cnf flder t the <Slr_hme>\cnfigsets\ucmdb_ cnfigs\cnf flder: mappings.txt prtwrds.txt schema.xml slrcnfig.xml stpwrds.txt stpwrds_en.txt synnyms.txt 3. Start Slr. T d this, g t the <Slr_install_dir>\bin directry in a cmmand prmpt, and then run the fllwing cmmand: slr start -s <Slr_hme> Nte: <Slr_install_dir> is the directry where the Slr package is extracted. <Slr_hme> is the full path t the Slr hme yu created in Step 2.a. T check if Slr is started, g t which is the URL fr Slr dashbard. T stp Slr, run the slr stp -all cmmand in the same directry. HPE Universal CMDB (10.31) Page 110 f 300

111 Chapter 5: UCMDB Server Administratin 4. Add the fllwing settings int <UCMDB_Server_Hme>\cnf\settings.verride.prperties. cmdb.search.slr.standalne=true cmdb.search.slr.standalne.url= Nte: The value fr cmdb.search.slr.standalne.url shuld be the URL verified in Step Increase Slr memry size. By default Slr allcates nly 512MB RAM. Yu might need t increase this setting, depending n the server s RAM and ther prcesses that run n the same server. T increase Slr memry size, a. Open the fllwing file using a text editr: Windws: <UCMDB_install_dir>\slr\bin\slr.in.cmd Linux: <UCMDB_install_dir>/slr/bin/slr.in.sh b. Lcate the fllwing setting and increase the setting t a desired value: Windws: set SOLR_JAVA_MEM=-Xms512m -Xmx2048m where Xms is the initial amunt, Xmx is the ttal amunt f memry allcated. Linux: c. Save the file. SOLR_JAVA_MEM="-Xms512m -Xmx2048m" 6. Restart the UCMDB Server. Hw t Run Slr in a Different Prcess than UCMDB Starting frm UCMDB versin 10.30, Slr is running by default in a different prcess than UCMDB. Nw, Slr features a Web interface that makes it easy and safe fr the users t access it. T pen the Slr's main dashbard, launch the Web brwser and enter the fllwing address: Nte: Yu can pen the Slr's main dashbard thrugh lcalhst access nly. HPE Universal CMDB (10.31) Page 111 f 300

112 Chapter 5: UCMDB Server Administratin Every 60 secnds, the UCMDB server verifies if the Slr is running. If fr sme reasn the Slr stps running, the UCMDB server tries three times t restart it. T change the interval at which the UCMDB Server verifies if the Slr is running: 1. G t JMX Cnsle > UCMDB:service=Settings Services > setglbalsettingvalue. 2. In the name field enter cmdb.slr.fallback.perid.in.secnds. 3. In the value filed, specify a time interval in secnds. The default value is 60 secnds. 4. Click Invke. 5. Restart the UCMDB Sever. Change the Default Prt f the Slr The default prt value (8983) f the Slr may cnflict with an existing applicatin (fr example, anther web applicatin already uses this prt). If such a cnflict exists, change the default prt as fllws: 1. In UCMDB, g t Administratin > Infrastructure Settings Manager > General Settings. 2. In the Name clumn, chse The prt n which slr will start. 3. In the Value clumn, change the 8983 t any ther prt number. 4. Click Save. 5. Restart the UCMDB server. Mdify Slr Memry Size The estimated amunt f disk space and memry necessary fr Slr t run prperly are as fllws: Minimal Recmmendatin Memry (RAM) Disk Space 512 MB / millin f CIs 3 GB / millin f CIs The estimated disk space and memry requirements may vary up r dwn, depending n the fllwing: The CI Types f the indexed CIs. The size f the indexed CI's attributes. The type f the indexed CI's attributes (string, date, numeric). HPE Universal CMDB (10.31) Page 112 f 300

113 Chapter 5: UCMDB Server Administratin The number f Slr queries expected t run in a certain interval. The rate at which the CIs are added/updated/deleted in the index (the data-in rate). Yu can change the amunt f memry allcated fr the Slr's usage as fllws: 1. Open the fllwing file using a text editr: Windws: <UCMDB_install_dir>\slr\bin\slr.in.cmd Linux: <UCMDB_install_dir>/slr/bin/slr.in.sh 2. Lcate the fllwing setting and mdify the setting t a desired value: Windws: set SOLR_JAVA_MEM=-Xms512m -Xmx2048m where Xms is the initial amunt, Xmx is the maximum amunt f memry allcated. Linux: SOLR_JAVA_MEM=-Xms512m -Xmx2048m Nte: By default, the initial amunt f memry allcated is 512 MB, and the maximum amunt f memry that can be allcated is 2 GB. 3. Save the file. 4. Stp Slr. T d this, g t the <UCMDB_install_dir>\bin directry in a cmmand prmpt, and then run the fllwing cmmand: Windws: slr stp Linux:./slr.sh stp Nte: After yu stp Slr, the UCMDB Sever autmatically restarts it, and the changed setting takes effect. Slr Aut Cmmit Starting frm UCMDB versin 10.31, the SOLR aut cmmit feature is enabled by default, this means that SOLR will autmatically cmmit dcuments (indexed CI data). A cmmit peratin makes index changes visible t new search requests. Slr uses tw types f aut cmmit peratins: HPE Universal CMDB (10.31) Page 113 f 300

114 Chapter 5: UCMDB Server Administratin hard aut cmmit. Writes dcuments t disk, but the dcuments are nt visible fr searching. The interval fr hard aut cmmit is set t 15 secnds r dcuments. sft aut cmmit. Makes dcuments available fr searching. The interval fr sft aut cmmit is set t 3 minutes. Since UCMDB can run heavy data-in peratins, by setting these values the updated data is ften sent t Slr, therefr the Slr's perfrmance is imprved. Hwever, if necessary, yu can change the aut cmmit interval as fllws: Hard aut cmmit interval 1. Open the <Slr_hme>\cnfigsets\ucmdb_cnfigs\cnf\slrcnfig.xml file. 2. In the belw lines replace the values f the maxtime and maxdcs parameters with the nes yu desired: <autcmmit> <maxtime>${slr.autcmmit.maxtime:15000}</maxtime> <maxdcs>10000</maxdcs> <pensearcher>false</pensearcher> </autcmmit> 3. Restart the UCMDB server. Sft aut cmmit interval 1. Open the <Slr_hme>\cnfigsets\ucmdb_cnfigs\cnf\slrcnfig.xml file. 2. In the belw lines replace the value f the maxtime parameter with the ne yu desired: <autsftcmmit> <maxtime>${slr.autsftcmmit.maxtime:180000}</maxtime> </autsftcmmit> 3. Restart the UCMDB server. Nte: Als, the SOLR versin in is upgraded frm t Fr differences between SOLR versins and 6.2.1, see Majr Changes frm Slr 5 t Slr 6. HPE Universal CMDB (10.31) Page 114 f 300

115 Chapter 5: UCMDB Server Administratin Hw t Set UCMDB Server Time, Change Time Zne Setting, r Crrect System-induced Clck Drift Nte: UCMDB server (als all HA ndes servers) and the database server shuld be based n UTC time. This helps preventing issues caused by time zne and daylight savings time changes. When changing the UCMDB server system time backward r frward n the database server, administratrs shuld fllw a scenari that eliminates risk f unrespnsive servers and/r data incnsistencies (fr bth standalne r high-availability based UCMDB systems). T d s, 1. Stp UCMDB server. In case f cluster envirnment, stp all the ndes. 2. Perfrm actins needed t change the system time. 3. On the UCMDB server machine, execute the fllwing cmmand: Windws: G t the C:\hp\UCMDB\UCMDBServer\tls\dbscripts flder, and run the fllwing cmmand frm cmmand prmpt: dbtl resetclustercnf Linux: /pt/hp/ucmdb/ucmdbserver/tls/dbscripts/dbtl.sh resetclustercnf 4. Restart UCMDB server. Hw t Disable Caching f Generated IDs fr CIs, Jbs, and URM Resurces Versin intrduced a new setting -Dcache.usage.id.generatin.enabled in the wrapper.cnf file fr enabling/disabling caching f generated IDs fr CIs, jbs, and URM resurces. Yu may disable the caching in rder t use the ld cache when necessary, fr example, when yu encunter heap space cnsumptin issue. T d s, 1. Lcate the c:\hp\ucmdb\ucmdbserver\bin\wrapper.cnf file. 2. Uncmment the fllwing lines: #Enables caching f the generated IDs fr CIs, jbs, and urm resurces HPE Universal CMDB (10.31) Page 115 f 300

116 Chapter 5: UCMDB Server Administratin #wrapper.java.additinal.57=-dcache.usage.id.generatin.enabled=true By default caching is disabled as the abve lines are cmmented ut. 3. Restart the UCMDB Server fr the change t take effect. Hw t Increase the Java Heap Memry Used by the UCMDB UI Java Applet This can be dne using ne f the fllwing tw methds: Editing the JSP File Editing the Cntrl Panel Java Settings Editing the JSP File This change affects all applets launched frm the Internet brwsers n all different cmputers frm where the UCMDB UI is accessed. T perfrm the change n the UCMDB server cmputer, d the fllwing: 1. Stp the UCMDB Server. 2. Increase UCMDB server's memry. a. Open the <UCMDB_Server_Hme>\bin\wrapper-platfrm.cnf file. b. Change the values fr wrapper.java.initmemry and wrapper.java.maxmemry t 4GB r greater as fllws: wrapper.java.initmemry=4096 wrapper.java.maxmemry=4096 c. Save the file. 3. Increase UCMDB Applet's memry. a. Open the <UCMDB_Server_Hme>\deply\ucmdb-ui\applet\applet.jsp file. b. Change the java_arguments parameter value t specify the amunt f memry in megabytes, fr example, t use 1280 MB, change it as fllws: <param name="java_arguments" value="-xmx1280m -Xms1280m"> HPE Universal CMDB (10.31) Page 116 f 300

117 Chapter 5: UCMDB Server Administratin c. Delete all files in the fllwing flders: UCMDB r earlier: <UCMDB_Server_Hme>\runtime\jetty-cache\ <UCMDB_Server_Hme>\runtime\jsp\ UCMDB r later: <UCMDB_Server_Hme>\runtime\jetty-cache\ 4. Start the UCMDB Server. Editing the Cntrl Panel Java Settings This change nly takes effect n the cmputer n which the Internet brwser that is used t access the UCMDB UI is run. T perfrm the change n the cmputer which is used fr accessing the UCMDB UI, d the fllwing: 1. Frm the Start menu, search Java. 2. Click Cnfigure Java. 3. In the Java Cntrl Panel, g t the Java tab, and click View. 4. In the Java Runtime Envirnment Settings dialg, duble-click the value field fr the Runtime Parameters clumn, and enter the amunt f memry in megabytes in the -Xmx cmmand line switch, fr example, -Xmx1280m. 5. Click OK. HPE Universal CMDB (10.31) Page 117 f 300

118 Chapter 5: UCMDB Server Administratin 6. Click Apply and then click OK. 7. Clse all pen Internet brwser windws and restart the UCMDB UI. Hw t Cnfigure Cnfiguratin Manager t Cnnect t UCMDB Server Versin f the HPE Cnfiguratin Management System cnsists f Universal CMDB (UCMDB) and Universal Discvery (UD). It des nt include a new release fr Cnfiguratin Manager. The latest release f Cnfiguratin Manager is versin (it is recmmended t have CM CUP3), yu can use it in tandem with versin f Universal CMDB. In case yu encunter any issue cnnecting Cnfiguratin Manager CUP3 (r with a later CUP n tp f versin 10.22) t UCMDB server 10.30, cnfigure CM as fllws: 1. Cpy server.keystre frm the C:\hp\UCMDB\UCMDBServer\cnf\security directry t the C:\hp\CM_ \java\windws\x86_64\lib\security\ directry. 2. Edit the C:\hp\CM_ \servers\server-0\cnf\server.xml file. Find the line with cnnectr 8143, replace the line with the fllwing and save the file: <Cnnectr prt="8143" prtcl="http/1.1" SSLEnabled="true" maxthreads="150" scheme="https" secure="true" keystrefile="c:/hp/cm_ /java/windws/x86_64/lib/security/server.keystre" keystrepass="hppass"/> 3. In a web brwser, enter the URL f the UCMDB server: name r IP address>.<dmain name>:8443 where <server name r IP address>.<dmain name> represents the fully qualified dmain name (FQDN) f the HPE Universal CMDB Server. 4. Find the icn that indicates a secure cnnectin, click it, and exprt the certificate with the name hpcert.cer. 5. Cpy the just exprted certificate int the C:\hp\CM_ \java\windws\x86_64\bin flder. 6. Frm the C:\hp\CM_ \java\windws\x86_64\bin flder, run the fllwing: keytl -imprt -alias hp -file hpcert.crt -keystre "C:\hp\CM_ \java\windws\x86_64\lib\security\cacerts" Nte: The passwrd is changeit. HPE Universal CMDB (10.31) Page 118 f 300

119 Chapter 5: UCMDB Server Administratin 7. Change the CM URL in the UCDMB Server fr CM t wrk with HTTPS. a. Lg in t UCMDB Server. b. G t Administratin > Infrastructure Settings Manager > General Settings. c. Lcate the Cnfiguratin Manager URL setting, and change its value t SERVER>:8143/cnc. d. Click Save. e. Lg ut and lg in t UCMDB Server again fr the change t take effect. Hw t View the KPI Dashbard Yu can use the key perfrmance indicatr (KPI) dashbard in the JMX cnsle t view the fllwing infrmatin f the UCMDB Server: Database cnnectin summary Discvery prcessing statistics Operatins infrmatin Fllw these steps t view the KPI dashbard: 1. Launch a web brwser and enter the fllwing address: Yu may have t lg in with a user name and passwrd. 2. Lcate KPI:service=Dashbard and click the link t pen the JMX MBEAN View page. 3. Invke ne f the fllwing methds: viewdbcnnectinsummary: displays database cnnectin summary viewdiscveryprcessingstatistics: displays discvery prcessing statistics viewoperatinsinfrmatin: displays peratins infrmatin Nte: The shwhtml ptin cntrls if the infrmatin is displayed in the HTML r JSON frmat. True: the infrmatin is displayed in the HTML frmat False: the infrmatin is displayed in the JSON frmat If the database is Oracle, the viewdbcnnectinsummary methd can gather and display database sessins. T enable this capability, the custmer DBA must grant rights t the UCMDB: HPE Universal CMDB (10.31) Page 119 f 300

120 Chapter 5: UCMDB Server Administratin grant select n v_$sessin t <db_schema>; grant select n v_$lcked_bject t <db_schema>; grant select n v_$sqlarea t <db_schema>; grant select n v_$transactin t <db_schema>; The UCMDB Server regularly exprts the infrmatin displayed in the KPI dashbard int the fllwing flder: UCMDBServer/runtime/lg/statistics/metrics_jsn. The autmatic exprt is perfrmed by a scheduled jb: KPI Dashbard Dump, which by default runs hurly. The exprted files have names that resemble the fllwing examples: DbCnnectinSummary jsn DiscveryPrcessingStats jsn If yu want t start r stp this autmatic exprt, use ne f the fllwing ptins: Activate r deactivate the KPI Dashbard Dump jb frm Administratin > Scheduler Set the statistics.gathering.enabled setting t true (activate) r false (deactivate). Perfrmance Statistics Dashbard The UCMDB Server autmatically captures perfrmance metrics and saves the data statistically in.csv files under the UCMDBServer\runtime\lg\statistics\metrics flder. T define the interval (measured in minutes) at which the UCMDB Server gathers perfrmance metrics: 1. In UCMDB, g t Administratin > infrastructure Settings Manager > General Settings. 2. Lcate Statistics gathering interval setting and specify a time interval in minutes. The default value is 15 minutes. 3. Restart the UCMDB Server. The fllwing table explains each clumn in the.csv files. Clumn t Infrmatin Timestamp (epch) cunt Number f invcatins 1 max Max invcatin duratin 1 HPE Universal CMDB (10.31) Page 120 f 300

121 Chapter 5: UCMDB Server Administratin Clumn Infrmatin mean Average invcatin duratin 1 min Min invcatin duratin 1 stddev Standard Deviatin f the values p50 50% quantile 12 p75 75% quantile 12 p95 95% quantile 12 p98 98% quantile 12 p99 99% quantile 12 p % quantile 12 mean_rate m1_rate m5_rate m15_rate rate_unit duratin_unit Average event rate (per secnd) Average event rate in the last minutes Average event rate in the last 5 minutes Average event rate in the last 15 minutes Unit fr the rate (fr example, calls/secnd) Unit fr the duratins (fr example, secnds) Nte: 1. All these values are cllected since the last metric reset. Every 15 minutes after dumping the statistics t a CSV, the metrics (cunters, duratins) are reset t A quantile is calculated by taking the entire data set, srting it, and taking the value in the middle (r 1% frm the end, fr the 99th percentile). Fr example, the 75% quantile shws the median f the lwer 75% values. These quantiles apply t the set f duratins f each invcatin. Cunters are nt reset every 15 minutes, s their values keep grwing and shw verall cunts since the system startup. HPE Universal CMDB (10.31) Page 121 f 300

122 Chapter 5: UCMDB Server Administratin Captured Metrics The fllwing tables shw the captured metrics. Data-in statistics Metrics Measurement Nte datain.<submdule> Timer A breakdwn f times in the data in prcess, by submdule (and submdules f submdules) data-in.ttal Timer An verall timer frm start t end fr the data-in peratin UCMDB API Request statistics Metrics Measurement Nte api-executed.<operatin> Timer A timer ver API requests api-failed Cunter A cunter that shws the number f failed API requests Server Sessin statistics Metrics server-sessins Measurement Cunter DB Cnnectin statistics Metrics db-cnnectin-brrwed db-cnnectin-brrw-failed db-cnnectin-returned db-cnnectin-invalidated Cnnectin timers Measurement Cunter Cunter Cunter Cunter Timer HPE Universal CMDB (10.31) Page 122 f 300

123 Chapter 5: UCMDB Server Administratin DAL statistics Metrics Measurement Nte Timer A timer ver the executin f a specific, lng-running SQL (>1 minute) dal-executed Timer Overall timer acrss all DAL executins dal-failed Cunter db-rws-updated Cunter A cunter shwing hw many rws all the SQLs mdified TQL statistics Metrics Measurement Nte Timer A timer ver the executin f a specific, lng-running TQL (>1 minute) tql-calculatin Timer Overall timer acrss all TQL executins tql-results Timer Cunter fr the ttal amunt f CIs returned by TQL queries s far Startup statistics Metrics Measurement Nte startup Timer A timer ver the startup f UCMDB and shws the time needed fr the server startup Operatin statistics Metrics Measurement Nte dalexecuted.<sql> tqlcalculatin.<tql> peratinexecuted.<"sync"/"async">. <CallerApp>.<OperatinName> Timer Timers ver specific peratins sync : the caller is waiting fr the peratin t finish async : the peratin runs in an async thread peratin-executed."end-t-end" Timer Timers that are ver end-t-end peratins, HPE Universal CMDB (10.31) Page 123 f 300

124 Chapter 5: UCMDB Server Administratin Operatin statistics, cntinued Metrics Measurement Nte.<"sync"/"async">. <CallerApp>.<OperatinName> meaning the peratin in the timer name is the first peratin in an peratin call stack peratin-failed Cunter A cunter that shws the number f failed peratins UI Server statistics Metrics Measurement Nte ui-service-executed.<service> Timer Timers ver specific UI Server service calls ui-service-failed.<service> Cunter JVM statistics Metrics "gc" "buffers" "memry" "threads" Jetty statistics Metrics war-cntext-handler.<cntext> rt-handler empty-rt-handler jetty-cnnectins HPE Universal CMDB (10.31) Page 124 f 300

125 Chapter 5: UCMDB Server Administratin Jetty Queued Thread Pl Metrics utilizatin utilizatin-max size jbs Statistics n verall cunters (bjects, links, merges) fr data-in peratins Metrics Measurement merged-cis type_changes merge-peratins ignred-frm-cmdb ignred-frm-bulk updated-bjects updated-links Cunter Cunter Cunter Cunter Cunter Cunter Cunter Hw t Enable License Usage Tracking Universal CMDB can reprt the license usage infrmatin t HPE Usage Hub. T enable this feature, fllw the steps belw: Nte: Make sure Usage Hub is already set up. Otherwise, this feature des nt wrk. Fr mre infrmatin abut Usage Hub, refer t HPE Live Netwrk: 1. In UCMDB, select Administratin > Infrastructure Settings > General Settings. 2. Set the License usage tracking setting t True. HPE Universal CMDB (10.31) Page 125 f 300

126 Chapter 5: UCMDB Server Administratin 3. Specify the URL f the Usage Hub service in the license.usage.tracking.hub.name setting. 4. Restart the UCMDB Server. Hw t Use the External JAR Cnfiguratin File Starting frm 10.30, yu can custmize the service-cnfig.xml file frm a JAR file and save it t the fllwing directry t verride the default cnfiguratins f the JAR file: <UCMDB_Server_Hme>\cnf\service-cnfig\<the_same_path_as_in_the_JAR>\ The directry structure under the service-cnfig flder must be the same as the path t the servicecnfig.xml file in the JAR file. Fr example, the fllwing directries are fr authrizatin.jar and recnciliatin.jar respectively: <UCMDB_Server_Hme>\cnf\service-cnfig\services\authrizatin\service-cnfig.xml <UCMDB_Server_Hme>\cnf\service-cnfig\services\recnciliatin\service-cnfig.xml If a crrectly cnfigured service-cnfig.xml file is present in the abve lcatin, the UCMDB server n lnger lads the default cnfiguratins frm the crrespnding JAR file. Instead, the UCMDB server nly lads the cnfiguratins specified in this external service-cnfig.xml file fr the crrespnding JAR file. Nte: After yu cnfigure the external service-cnfig.xml file as mentined abve, yu need t restart the UCMDB server fr the changes t take effect. As an example f hw t d this, see Hw t Mdify the Maximum Thread Numbers f the Data In Service in the HPE Universal CMDB Data Flw Management Guide. UCMDB Services View the Status f HPE Universal CMDB Server Services On the UCMDB Server machine, pen yur client brwser and enter The Status and Detailed Status f all services are displayed, indicating whether the HPE Universal CMDB services are running (Up) r are dwn (Nt Started). Nte: In case there are services that are nt running, cntact HPE Sftware Supprt. HPE Universal CMDB (10.31) Page 126 f 300

127 Chapter 5: UCMDB Server Administratin HPE Universal CMDB Services The HPE Universal CMDB services are described in the fllwing table: Service Name authrizatin autdiscvery Descriptin f Service Respnsible fr the security mdel enfrcement (users, rles, tenants, and s n). Respnsible fr Data Flw Management-related services. HPE Universal CMDB (10.31) Page 127 f 300

128 Chapter 5: UCMDB Server Administratin Service Name Brwser_ resurces cla_queue cla_statistics classmdel cmdb_md_ nt cmdb_sys_ tqls cmdb_view cmdb_widget_ tracker cnfiguratin cntent-install crrelatin enrichment fcmdb-cnfig dataacquisitin fcmdbmanagement flders framewrk Descriptin f Service Respnsible fr managing UCMDB brwser related resurces like categries. Respnsible fr Client level authrizatin. Respnsible fr Client level authrizatin. Respnsible fr maintaining the class mdel in the CMDB. Respnsible fr ntificatins f changes that ccur in the CMDB. Respnsible fr the cnditins applied t TQL ndes, and the cnditin results that are stred in the system TQL. Respnsible fr calculating view definitins ver TQL results (the transfrmatin frm graph t tree is given the view definitin). Respnsible fr managing UCMDB brwser widgets. Respnsible fr snapshts, CI change queries, and TQL/View Histry queries. Respnsible fr managing the cntent packs. Respnsible fr HPE Universal CMDB impact, rt cause, and crrelatin subsystems. Respnsible fr managing integratins. Respnsible fr executing bth ad hc and active enrichments. A cache mechanism fr federated data that allws basic FCMDB services befre the FCMDB is fully laded. Respnsible fr managing the adapters, federatin, and the data push flw. Respnsible fr managing the flder hierarchy fr every type f resurce. Respnsible fr dispatching peratins within the UCMDB server. HPE Universal CMDB (10.31) Page 128 f 300

129 Chapter 5: UCMDB Server Administratin Service Name generic_ adapter_ manager gruping histdb impact licensing mappingengine mdel mdel_ statistics mdel_ tplgy mdel_update msg_sync ffline_tql packaging recnciliatin recnciliatin_ cnf Descriptin f Service Respnsible fr generic adapter related peratins. Respnsible fr hlding the different bundles that allw the classificatin f resurces. Respnsible fr saving changes t CIs and relatinships in the CMDB. Respnsible fr HPE Universal CMDB impact, rt cause, and crrelatin subsystems. Respnsible fr license management. Used by the integratins. Allws recnciliatin during a federated TQL calculatin. Respnsible fr mapping CIs frm external data surces t lcal CMDB CIs. Allws running database ptimizatin peratins. These peratins are run in varius scenaris, such as histry, upgrade, and JMX. Respnsible fr lading the mdel tplgy graph (an internal data structure that cntains all CIs and relatinships withut prperties and ften allws aviding database queries). Respnsible fr managing updates t the class mdel in the CMDB. Messaging service fr asynchrnized histry change messages. Respnsible fr managing and executing queries needed fr CI tracking in UCMDB Brwser. Respnsible fr packages. Packages are zip files cntaining resurces that are structured in rganized, predefined subdirectries. The CMDB s data ppulatin recnciliatin service. Respnsible fr the recnciliatin engine f HPE Universal CMDB. Handles the recnciliatin cnfiguratin such as identificatin rules and recnciliatin pririty cnfiguratin HPE Universal CMDB (10.31) Page 129 f 300

130 Chapter 5: UCMDB Server Administratin Service Name reprt scheduler sftwarelibrary state_ management system-health tplgy_ search tql tql_res_utils tql_tracker view wrld Descriptin f Service Respnsible fr HPE Universal CMDB reprt services, such as adding, editing, and remving System reprts, calculatin f Asset reprts, Nde Dependency reprts. Respnsible fr scheduling ffline tasks. Sftware library (Teaching server) service fr SAI editr/express Teaching peratins Respnsible fr managing states. Respnsible fr gathering a string server related statistics. Respnsible fr search engine related services. Respnsible fr TQL calculatins. Respnsible fr TQL result maintenance (active) and layut retrieval. Respnsible fr managing UCMDB brwser CI tracking. Respnsible fr part f the business lgic f the Mdeling Studi, including "watch". A central repsitry fr cnfiguratin infrmatin that is gathered frm the varius HPE Universal CMDB and third-party applicatins and tls. This infrmatin is used t build HPE Universal CMDB views. UCMDB Server Prts The fllwing prts are used by the UCMDB server: Prtcl Prt Prcess Descriptin TCP 8080 ucmdb_ server.exe Default Jetty HTTP prt. Nte: Disabled by default in and later. T enable HTTP cmmunicatin, see "Hw t Enable HTTP Cmmunicatin fr HPE Universal CMDB" in this guide. HPE Universal CMDB (10.31) Page 130 f 300

131 Chapter 5: UCMDB Server Administratin Prtcl Prt Prcess Descriptin TCP 8443 ucmdb_ server.exe TCP 8444 ucmdb_ server.exe Default Jetty HTTPS prt. Default Jetty HTTPS prt with client authenticatin. TCP UDP ucmdb_ server.exe ucmdb_ server.exe Default JGrups prt (HA). Multicast JGrups prt (HA). TCP & UDP 7500 ucmdb_ server.exe Default JGrups diagnstic prt (HA). TCP ucmdb_ server.exe JMX remte prt (JBss RMI Agent). TCP TCP TCP ucmdb_ server.exe wrapper.exe wrapper.exe Callback prt n UI server (used by RMI). Prt used by the wrapper.exe prcess t cmmunicate with the UCMDB Server JVM prcess. Prt used by the UCMDB Server JVM prcess t cmmunicate with the wrapper.exe prcess. TCP 5431 PstgreSQL Default prt fr lcal installed PstgreSQL database. UCMDB Integratin Service Prts The fllwing prts are used by the UCMDB Integratin Service: Prt Descriptin 1977 Data Flw Prbe s web applicatin prt. Used fr JMX cnsle and ther web services. HPE Universal CMDB (10.31) Page 131 f 300

132 Chapter 5: UCMDB Server Administratin Prt Descriptin 8453 Data Flw Prbe s secured web applicatin prt. Same as 1977, and is used fr the JMX cnsle and ther web services if the Jetty HTTPS mde is enabled Prt used by the Tanuki wrapper. UCMDB Lg Files CMDB lg files enable yu t perfrm basic trubleshting f CMDB runtime prblems. Additinally, by tracking the CMDB behavir in the lg files, yu can examine the effects f changes made in the system. The CMDB is cmpsed f subsystems and each subsystem recrds t several lg files. CMDB Server lgs have cnsistent frmat. The rder is data and time: (frmat "yyyy-mm-dd hh:mm:ss:sss") lglevel [Thread Name]. The wrapper lg is an exceptin t this standard. These settings can be changed frm lg prperties files lcated in the UCMDBServer\cnf\lg\ flder. Lg files are lcated in: Windws: C:\hp\UCMDB\UCMDBServer\runtime\lg Linux: /pt/hp/ucmdb/ucmdbserver/runtime/lg Nte: UCMDB lg levels shuld be set t the OOTB values. They may be increased when investigating issues. Hwever, after btaining the required infrmatin the lg levels shuld be reverted. Increased lg levels fr a lnger perid f time may have an impact ver perfrmance. If yu want t delete the lgs, yu shuld delete the cntent in the lg flder nly, and never delete the flder itself. Make sure that the lg flder always exists. If the lg flder is deleted accidentally, create the lg flder manually befre starting up the UCMDB Server. This sectin includes the fllwing tpics: "General Lg Files" n the next page "Class Mdel Lg Files" n page 135 "TQL Lg Files" n page 136 "Data-In Lg Files" n page 137 "Histry Lg Files" n page 137 "Enrichment Lg Files" n page 140 "Dal Lg Files" n page 140 HPE Universal CMDB (10.31) Page 132 f 300

133 Chapter 5: UCMDB Server Administratin "Authrizatin Lg Files" n page 141 "UCMDB UI Lg Files" n page 142 "Data Flw Management Lg Files" n page 143 General Lg Files Quta Lg Parameters The lg name is cmdb.quta.lg. Lg File Purpse Infrmatin Level Errr Level Debug Level Basic Trubleshting Descriptin Quta names, quta values, and current quta levels. Quta names and values set in the server and custmer levels during a custmer lad. CMDB peratins that fail because they exceed quta limits. A cunt cllectr runs every n minutes and gathers current cunts fr all qutas. Cllected cunts are lgged. If peratins fail because f quta limits, check the cunt grwth and quta values. CMDB Operatin Statistics Lg The lg name is cmdb.peratin.statistics.lg. The lg des nt appear in the lg flder by default. Only when yu perfrm sme specific actin, the lg becmes available. Fr example, when yu invke the resetoperatinstatistics JMX methd frm the Framewrk Services categry, it resets CMDB Server Operatin Statistics and writes dump t this lg. Lg File Purpse Infrmatin Level Descriptin Statistics fr all peratins perfrmed in the past 15 minutes including wrst peratin instances. Statistics per peratin including peratin class name, caller applicatin, and HPE Universal CMDB (10.31) Page 133 f 300

134 Chapter 5: UCMDB Server Administratin Lg File Descriptin custmer ID. Default f 10 wrst peratin instances. Errr Level Debug Level Basic Trubleshting Disables the statistics feature. Nt available. Check when there is a perfrmance slwdwn. Cnfiguratin Lg The lg name is cnfiguratin.lg. Lg File Purpse Descriptin Cntains basic envirnment details, including: Server versin and CUP versin Database vendr and versin Cntent pack versin High Availability cnfiguratin Data Flw Prbe versin Changes t settings (each setting is audited in the lg) Infrmatin Level Errr Level Debug Level Basic Trubleshting Infrmatin is written t the lg when the system starts up r when a setting is changed. Nt available. Nt available. Used by Custmer Supprt t help reprduce custmer prblems. HPE Universal CMDB (10.31) Page 134 f 300

135 Chapter 5: UCMDB Server Administratin Class Mdel Lg Files CI Type Mdel Lg The lg name is cmdb.classmdel.lg. This lg shuld appear when yu perfrm peratins n the UCMDB class mdel, like creating a new CI Type, r adding an attribute n an existing CI Type. Lg File Purpse Infrmatin Level Errr Level Debug Level Descriptin CI Type Mdel errrs and debug messages. When a CI Type Mdel is laded, incrrect definitins are lgged as infrmatinal messages. An example f an incrrect definitin is duplicate attributes. Nt available. Every CI Type update includes the fllwing: Original CIT in XML frmat New CIT in XML frmat Differences between the CITs If the CI Type Mdel update is rejected, the reasn is lgged. Basic Trubleshting Cmpares the differences that the server finds between the riginal CIT and the new CIT. This is useful t understand the fllwing scenaris: A CIT in a package failed An actin in the CIT brwser applet failed An actin in the CIT brwser applet succeeded when it shuld have failed HPE Universal CMDB (10.31) Page 135 f 300

136 Chapter 5: UCMDB Server Administratin TQL Lg Files CMDB Ntificatin Lg The lg name is cmdb.ntificatin.lg. Lg File Purpse Descriptin Ntificatin messages frm the time f the cmpnent's creatin in the CMDB until the client's listener receives a message. Mst cmpnents receive cnfiguratin changes frm the CMDB in push mde, by the ntificatin mechanism, rather than in pull mde. Infrmatin Level Startup and shutdwn f publishers Register and unregister remte and internal listeners Errr Level Errrs when messages are published Errrs when messages are received Debug Level Unique message ID Number f changes that a message includes as well as mre details accrding t the type f the message (fr example, the TQL result versin) JMS header prperties Basic Trubleshting If an applicatin des nt receive a ntificatin, check the fllwing: a listener is registered with the apprpriate ntificatin filter a message is published with data that matches this filter a message is received by the listener (use the unique message ID t verify) HPE Universal CMDB (10.31) Page 136 f 300

137 Chapter 5: UCMDB Server Administratin Data-In Lg Files CMDB Mdel Audit Shrt Lg The lg name is cmdb.mdel.audit.shrt.lg. Lg File Purpse Descriptin Infrmatin abut a CI Type peratin: type f peratin, data received as input, and what happened t the data in each CIT. Als cntains infrmatin abut the caller applicatin, executin time, and persistency time. Infrmatin Level Errr Level Debug Level Basic Trubleshting Operatin details. Nt available. Nt available. If there are n changes when there shuld be, check the fllwing: Whether the peratin exists. Whether the input is crrect. What happened t the data. There may have been a false update. This is especially useful when running DFM t trace the input. Histry Lg Files Histry Lg The lg name is histry.lg. Lg File Purpse Descriptin Recrds general histry events Infrmatin Level Aut cmpletin events HPE Universal CMDB (10.31) Page 137 f 300

138 Chapter 5: UCMDB Server Administratin Lg File Descriptin Aut cmplete table lck/unlck messages Tenants bitmask clumn size handling Delete custmer fuse ntice Debug Level Aut cmpletin details Histry Rt table handling messages Histry Audit Update Lg The lg name is histry.update.audit.lg. Lg File Purpse Descriptin Tracks events saved in the Histry tables Infrmatin Level Details all events stred in the histry tables Event statistics Debug Level Database statistics Histry Partitin Lg The lg name is histry.partitin.lg. Lg File Descriptin Purpse Recrds histry partitin data. Recrds the Baseline prcess events. Infrmatin Level Add/Remve partitin histry tables Baseline events Baseline statistics Errr Level Table partitin failures Baseline prcess failures HPE Universal CMDB (10.31) Page 138 f 300

139 Chapter 5: UCMDB Server Administratin Query Histry Lg The lg name is histry.queries.lg. Lg File Purpse Descriptin Recrds all the queries perfrmed n the histry tables. Infrmatin Level Query cnditin Query results summary Errr Level Fuse exceeded Debug Level Query cnditin details Query result details Histry Class Mdel Changes Lg The lg name is histry.classmdel.changes.lg. Lg File Purpse Infrmatin Level Errr Level Descriptin Tracks all the class mdel changes that affect the histry tables. Class aligning messages Errrs that ccurred during class aligning Histry Purging Lg The lg name is histry.purge.lg. Lg File Purpse Infrmatin Level Errr Level Debug Level Descriptin Recrds the Histry purging prcess events Purging prcess infrmatin Errrs that ccurred during the purging prcess Details abut purged data HPE Universal CMDB (10.31) Page 139 f 300

140 Chapter 5: UCMDB Server Administratin Enrichment Lg Files CMDB Enrichment Lg The lg name is cmdb.enrichment.lg. Lg File Descriptin Purpse Enrichment definitins: adding, updating, remving, and calculating. Calculatin results such as hw many CIs were added, hw many relatinships were remved, and s frth. Supplies the reasn fr a calculatin failure. Failure in a mdel update, hwever, is nt included since it is an asynchrnus executin. Infrmatin Level Errr Level Debug Level Basic Trubleshting Add, update, and remve enrichment definitins. Add, update, and remve CIs r relatinships t r frm a mdel. Calculatin failure. Traces the enrichment calculatin prcess. If n calculatin was carried ut, check the definitin f add enrichment. If there are n results, check the finish calculate entry. Dal Lg Files CMDB Dal Lg The lg name is cmdb.dal.lg. Lg File Purpse Infrmatin Level Descriptin Infrmatin abut activity that ccurred in the data access layer, the layer that wrks with the CMDB. Nt available. HPE Universal CMDB (10.31) Page 140 f 300

141 Chapter 5: UCMDB Server Administratin Lg File Descriptin Errr Level Cnnectin pl errrs Database errrs Cmmand executin errrs Debug Level All DAL cmmands executed All SQL cmmands executed Basic Trubleshting If yu suspect that CMDB actins are taking t lng, check the time spent n queries and updates in the DAL lgs and peratin lgs. Exceptin details and ID are entered int the lg. The exceptin ID appears in the exceptin itself. Authrizatin Lg Files CMDB Authrizatin Management Lg The lg name is security.authrizatin.management.lg. Lg File Purpse Infrmatin Level Descriptin Audit all mdificatins related t the authrizatin mdel. Creatin and deletin f users, user grups, tenants, rles, and resurce grups. Additin and remval f users frm user grups, changes t user passwrds, and changes in users' default tenants. Additin and remval f permissins frm rles and changes in read-nly status f rles. Additin and remval f resurces frm resurce grups. Changes in user rle assignments. Changes in resurce tenant assciatins. Errr Level Failure t create r mdify authrizatin resurces, such as trying t create a user with an existing name. HPE Universal CMDB (10.31) Page 141 f 300

142 Chapter 5: UCMDB Server Administratin Lg File Debug Level Basic Trubleshting Descriptin Web services lgin requests. May be used t track why a user n lnger has a specific permissin. CMDB Authrizatin Permissins Lg The lg name is security.authrizatin.permissins.lg. This lg cntains detailed infrmatin fr authrizatin and ut-f-the-bx infrmatin. T enable the print f infrmatin, yu may need t set the lg level t DEBUG. Lg File Purpse Debug Level Basic Trubleshting Descriptin Debug authrizatin permissins queries. Print all existing permissins fr the user currently lgged in, whenever they are queried in the server. T check a specific permissin issue,turn n the debug level, perfrm the actin in the UI, turn the debug level ff, and check the lg fr the existing permissins f the user. It is nt recmmended t keep this lg at debug level, because it generates a large amunt f printed utput. UCMDB UI Lg Files Client-side Applet Lgs The fllwing client side applet lgs are als available: applet-peratins.lg. Tracks the peratins that are executed frm the CMDB UI t the UCMDB server. applet-general.lg. General lg fr the UI. applet-cachestatistics.lg. Tracks statistics f the UI cache. applet-missing_resurces.lg. Missing resurces lg. HPE Universal CMDB (10.31) Page 142 f 300

143 Chapter 5: UCMDB Server Administratin applet-applet-tasks.lg. Lgs task executins. applet-timemeasure.lg. Lg fr measuring perfrmance. applet-memrytracker.lg. Tracks the memry usage f the UI. applet-errrs.lg. Lgs the errrs that ccurred in the UI Nte: UCMDB UI lg files are present in the %Temp%/UcmdbLg/lg flder n the machine frm which yu access the UCMDB UI. Data Flw Management Lg Files Data Flw Management lg files stre infrmatin abut data flw activity (discvery and integratins), as well as related errrs, that ccur n the Server side. mam.autdiscvery.lg Cntains infrmatin abut tasks running n the server. The server prvides services t the user interface r the Prbe Gateway, such as: activating jbs, prcessing results frm the Prbe, r creating tasks fr the Prbe. Level Errr Infrmatin Debug Descriptin All DFM prcess errrs n the server side. Infrmatin abut requests being prcessed. Lgs mainly fr debugging purpses. Basic Trubleshting. Check this lg when yu have invalid user interface respnses r errrs yu need t explre. This lg prvides infrmatin t enable yu t analyze the prblems. mam.autdiscvery.results.stat.lg Cntains the statistics f the results received frm the Prbe. mam.autdiscvery.accuratedependency.lg (Deprecated) Cntains infrmatin abut accurate dependency fr the Autmatic Service Mdeling feature. This lg is related t the ld ASM versin (befre Cntent Pack 18), and is n lnger in use. HPE Universal CMDB (10.31) Page 143 f 300

144 Chapter 5: UCMDB Server Administratin mam.dispatch.lg Cntains all the dispatch related infrmatin. T enable this lg, 1. Lcate and pen the <UCMDB_Server_Hme>/cnf/lg/mam.prperties file. 2. Manually add the fllwing settings int the mam.prperties file: lg4j.categry.mam.dispatch=${lglevel}, mam.dispatch.appender ####################################### ## mam.packaging ## ####################################### lg4j.appender.mam.dispatch.appender=cm.mercury.tpaz.cmdb.shared.base.lg. BetterRllingFileAppender lg4j.appender.mam.dispatch.appender.file=${lgs.dir}/mam.dispatch.lg lg4j.appender.mam.dispatch.appender.maxfilesize=${def.file.max.size} lg4j.appender.mam.dispatch.appender.maxbackupindex=${def.files.backup.cun t} lg4j.appender.mam.dispatch.appender.layut=rg.apache.lg4j.patternlayut lg4j.appender.mam.dispatch.appender.layut.cnversinpattern=${msg.layut} 3. Save the file. Autdiscvery Dal Lg The lg name is mam.autdiscvery.dal.lg. Lg File Purpse Infrmatin Level Errr Level Descriptin Hlds infrmatin n queries and ther actins taken n the server s database tables as part f the discvery prcess. A summary f actins taken and their results n the database (such as retrieving infrmatin, deleting recrds, and s n). All critical errrs that ccurred during the attempt t access the database. HPE Universal CMDB (10.31) Page 144 f 300

145 Chapter 5: UCMDB Server Administratin Lg File Debug Level Basic Trubleshting Descriptin Detailed infrmatin n query parameters and/r the results that are retrieved frm them If there are any database errrs r failures (such as cnnectin failed, technical errr in the query, and s n), the errr lg is included in this lg file als. wrkflw_sizing.lg Enabling this lg file helps yu t cllect running statistics (fr example, time spent n nrmalizatin and aut delete) f each mdules n a prbe. Hw t Enable this lg? T enable this lg, 1. On the prbe, lcate and pen the /cnf/lg/prbegwlg4j.prperties and /cnf/lg/prbemgrlg4j.prperties files. 2. Manually add the fllwing settings int each f the abve files: ####################################### ### cmdb.wrkflw.sizing ## ####################################### lg4j.categry.cmdb.wrkflw.sizing=info, cmdb_wrkflw_sizing lg4j.appender.cmdb_wrkflw_ sizing=cm.mercury.tpaz.cmdb.shared.base.lg.betterrllingfileappender lg4j.appender.cmdb_wrkflw_sizing.file=${lgs.dir}/wrkflw_sizing.lg lg4j.appender.cmdb_wrkflw_sizing.append=true lg4j.appender.cmdb_wrkflw_sizing.maxfilesize=512mb lg4j.appender.cmdb_wrkflw_sizing.threshld=info lg4j.appender.cmdb_wrkflw_sizing.maxbackupindex=10 lg4j.appender.cmdb_wrkflw_sizing.layut=rg.apache.lg4j.patternlayut lg4j.appender.cmdb_wrkflw_sizing.layut.cnversinpattern=<%d> [%-5p] [%t] (%F:%L) - %m%n lg4j.appender.cmdb_wrkflw_sizing.encding=utf-8 HPE Universal CMDB (10.31) Page 145 f 300

146 Chapter 5: UCMDB Server Administratin 3. Save the files. 4. Restart the prbe. Sample lg < :56:51,459> [INFO ] [PrbeGW Task Results Sender] (TaskResultsSenderThread.java:458) - [TaskResultsSenderThread.handleSuccessTriggers.start][desc=update ID mapping,size=1] < :56:51,460> [INFO ] [PrbeGW Task Results Sender] (TaskResultsSenderThread.java:481) - [TaskResultsSenderThread.handleSuccessTriggers.stp][desc=update ID mapping,size=1] Lg Severity Levels Each lg is set s that the infrmatin it recrds crrespnds t a certain severity threshld. Because the varius lgs are used t keep track f different infrmatin, each is pre-set t an apprpriate default level. Fr details n changing the lg level, see "Changing Lg Levels" n the next page. Typical lg levels are listed belw frm narrwest t widest scpe: FATAL. The lg recrds nly events that prevent the system frm functining. ERROR. In additin t Fatal events, the lg recrds events that adversely affect the immediate functining f the CMDB. When a malfunctin ccurs, yu can check if Errr messages were lgged and inspect their cntent t trace the surce f the failure. WARN. The lg's scpe includes, in additin t Fatal and Errr-level events, prblems fr which the CMDB is currently able t cmpensate and incidents that shuld be nted t prevent pssible future malfunctins. INFO. The lg recrds all activity. Mst f the infrmatin is nrmally rutine and f little use and the lg file quickly fills up. DEBUG. This level is used by HPE Sftware Supprt when trubleshting prblems. Nte: The names f the different lg levels may vary slightly n different servers and fr different prcedures. Fr example, INFO may be referred t as Always lgged r Flw. HPE Universal CMDB (10.31) Page 146 f 300

147 Chapter 5: UCMDB Server Administratin Changing Lg Levels If requested by HPE Sftware Supprt, yu may have t change the severity threshld level in a lg, fr example, t a debug level. Fr details n changing the lg level, see "Lg Cnfiguratin Dialg Bx" belw. Lg Cnfiguratin Dialg Bx This dialg bx enables yu t view Universal CMDB lgs and change the lg level. T access See als On the Status bar, click Lg Level Cnfiguratin Cnfiguratin... frm the Mdeling main menu. "Lg Severity Levels" n the previus page r select Tls > Lg User interface elements are described belw: UI Element Descriptin Apply. Click t apply the selected lg level t the lg. Appender Appender pane File Max file size Max backup index Lggers pane Lgger pane Lggers table The name f the appender. Displays details fr the appender yu selected in the Lggers pane. Click the link t pen the lg file in an editr. Maximum appender file size. Maximum number f backup indexes. Default: 5 An expandable list f Universal CMDB lgs. Select the required lg frm the list: the details f the lg appear in the lwer pane. Displays details fr the lgger yu selected in the Lggers pane. Displays a list f lggers (with Lgger Name and Lg level) fr the selected lg. HPE Universal CMDB (10.31) Page 147 f 300

148 Chapter 5: UCMDB Server Administratin UI Element Lg level Lgger's appender Appender file Descriptin Select a lg level frm the drp-dwn list. A string defining the lg categry. Fr internal use nly. The name f the lgger's appender file. Enhanced File Uplad Mechanism UCMDB intrduced check fr prper extensins f the files that a user selects fr uplading in the fllwing areas: Mdeling CI Type Manager > Imprt Frm XML (imprts a CI Type) Impact Analysis Manager > Imprt Frm XML Mdeling Studi > Imprt Frm XML (imprts queries and views) Administratin Package Manager > Deply packages Package Manager > Uplad Cntent Pack Data Flw Management Data Flw Prbe Setup > Deply Prbe Update Sftware Library > Imprt SAI File, Imprt SAI File frm CP The fllwing infrastructure settings are added t limit the file size fr uplading: Name Descriptin Default Value File uplad maximum file size fr archive type File uplad maximum file size fr XML type The maximum size in KB fr an archive file that will be upladed by a user The maximum size in KB fr an XML file that will be upladed by a user 500,000 (KB) 10,000 (KB) Trubleshting and Limitatins UCMDB Server Administratin This sectin describes trubleshting and limitatins fr UCMDB. HPE Universal CMDB (10.31) Page 148 f 300

149 Chapter 5: UCMDB Server Administratin If the wrapper.java.additinal.10=-xx:+heapdumponoutofmemryerrr parameter is set (it is enabled by default) in the wrapper.cnf file, then every time the server fails with an Out f Memry errr, it dumps the full memry t the disk. Since the memry cntents culd be very large, yu shuld delete these files t avid disk space prblems. When wrking in a Firefx brwser using Linux, if yu get an OutOfMemryErrr: PermGen space errr, fllw these steps: a. G t the bin directry f the Java installatin directry and pen the Cntrl Panel. b. In the Java tab, select View. c. In the Java runtime envirnment settings, under Runtime parameters, increase the - XX:MaxPermSize. When UCMDB is used in integratins, the fllwing characters shuld nt be used in the passwrd: All nn-ascii characters (valid ISO 8859/1 characters that are nt als ASCII characters) The fllwing special characters: the tab character, the space character, and [ \ ] ^ ` { } ~ " # % & +, / : < = If the "User {0} has exceeded the maximum number f lgin sessins" message is displayed, ensure that yu are prperly lgged ut frm ther sessins n ther cmputers. Fr example, clsing a tab r clsing the brwser des nt immediately clse a user sessin n the server. HPE Universal CMDB (10.31) Page 149 f 300

150 Chapter 6: Infrastructure Settings Manager This chapter includes: Infrastructure Settings Manager Overview 150 Infrastructure Settings Validatin 150 Infrastructure Settings Manager User Interface 153 Infrastructure Settings Manager Overview Yu can define the value f settings that determine hw Universal CMDB and its applicatins run. Cautin: By mdifying certain settings, yu may adversely affect the perfrmance f Universal CMDB. It is strngly recmmended nt t mdify any settings withut first cnsulting HPE Sftware Supprt r yur HPE Services representative. Infrastructure Settings Validatin By default, field validatin is enabled fr infrastructure settings values. Supprted validatin types include s, URLs, prts, prtcls, deprecated values, time values, and rt CI/relatinship. When yu cnfigure the value fr an infrastructure setting in the Infrastructure Settings Manager pane, if the value is valid, the backgrund fr the value cell remains as is. if the value is invalid, the backgrund fr the value cell turns red. T enable r disable infrastructure settings validatin 1. Access the Infrastructure Settings Manager by selecting Managers > Administratin > Infrastructure Settings Manager. 2. In the Categries navigatin pane, select General Settings. 3. In the Infrastructure Settings Manager pane, lcate Validate infrastructure settings. HPE Universal CMDB (10.31) Page 150 f 300

151 Chapter 6: Infrastructure Settings Manager 4. Click in the Value field, and then select True (enable) r False (disable) frm the drp-dwn list. 5. Click the Save buttn. 6. Lg ff and then lg in fr the change t becme effective. Validatin Types Validatin types are described in details belw: s Ensures that the cell value has a valid frmat. The validatin is perfrmed using the fllwing regex (als the default regex used in UCMDB fr validatin): ^[_A-Za-z0-9-]+(\.[_A-Za-z0-9-]+)*@(?:[A-Za-z0-9]{1}(?:[A-Za-z0-9-]*[A-Za-z0-9])?\.)+(?:[A-Za-z] {2,}) An address that satisfies all f the fllwing frmat requirements is cnsidered a valid value: Starts with letters, digits, r _ (underscre) Cntains letters, digits, _ (underscre), r. (dt) befre character Cntains character Cntains at least ne letter r digit after character and befre the. (dt) Can have ne r mre dmains after the. (dt), and the dmain must have tw r mre letters Prt Ensure that the cell value has a valid prt frmat. (Valid values: An integer between ) Prtcl Yu can chse ne r multiple valid prtcl values frm the drp-dwn list. Valid ptins include http and https. CIT/Relatinship Yu can select a CIT/Relatinship frm a drp-dwn CIT tree. HPE Universal CMDB (10.31) Page 151 f 300

152 Chapter 6: Infrastructure Settings Manager URL Ensure that the cell value has a valid URL frmat. The URL validatin is perfrmed using the java.net.url implementatin. URLs need t be strictly frmatted accrding t RFC2396. Examples f valid URL: Examples f invalid URL: fxqn:/us/va/restn/cnri/ietf/24/asdf%*.fred news: %asdghfh@inf.cern.ch Nte: Validatin f relative URLs is nt supprted, and the setting mam.server.lgut.frward.url is excluded frm the validatin. Deprecated Values All deprecated cell values have a dark gray cell backgrund. Time Values The integer number is fllwed by a time unit s that it is clear what the field represents (secnds, millisecnds, minutes, hurs). HPE Universal CMDB (10.31) Page 152 f 300

153 Chapter 6: Infrastructure Settings Manager Fr millisecnds: Example "3000 millisecnds" Fr secnds: Example "300 secnds" Fr minutes: Example "3 minutes" Fr hurs: Example "2 hurs" At a certain hur: The hur is an integer between 0-24 and is validated with cell value backgrund change (turning red n an invalid value). Infrastructure Settings Manager User Interface This sectin includes (in alphabetical rder): Change Default Value Dialg Bx 153 Infrastructure Settings Manager Page 154 Change Default Value Dialg Bx This dialg bx enables yu t edit the default values f the infrastructure settings. T access Select Infrastructure Settings Manager frm the Navigatin Menu r select Managers > Administratin > Infrastructure Settings Manager, select the required setting, and then click the Change Default Value buttn. Imprtant infrmatin The default values fr glbal settings cannt be altered. User interface elements are described belw: UI Element (A-Z) Default Value Factry Value Descriptin The mdified default value. The default value initially prvided by Universal CMDB. HPE Universal CMDB (10.31) Page 153 f 300

154 Chapter 6: Infrastructure Settings Manager Infrastructure Settings Manager Page This page enables yu t view and edit infrastructure settings. T access See als Select Infrastructure Settings Manager frm the Navigatin Menu r select Managers > Administratin > Infrastructure Settings Manager. "Infrastructure Settings Manager Overview" n page 150 User interface elements are described belw (unlabeled elements are shwn in angle brackets): UI Element (A-Z) Descriptin Save. Saves the changes yu have made. Prperties. Enables yu t view the infrastructure prperties fr the selected setting. Opens the Prperties windw. Restre Default. Restres the previus default value f the selected infrastructure setting. Change Default Value. Enables yu t edit an infrastructure setting. Opens the Change Default Value dialg bx. Categries pane Descriptin Filter by clumn Cntains a list f the infrastructure setting categries. Yu can either select a categry t view the infrastructure settings cnnected with that categry, r alternatively select <All> t display all the infrastructure settings. A descriptin f the infrastructure setting. Enables yu t define the criteria fr which infrastructure settings yu want t appear n the Infrastructure Settings Manager page. Frm the drp-dwn list, select the desired clumn as yur filter criteria. In the value bx, enter the text r part f the text fr which t search. reviewer_new Name Refresh Rate The name f the infrastructure setting. Indicates when the change takes effect in Universal CMDB after an infrastructure setting value is mdified. HPE Universal CMDB (10.31) Page 154 f 300

155 Chapter 6: Infrastructure Settings Manager UI Element (A-Z) Value Was mdified Descriptin The value f the infrastructure setting. Indicates if the parameter was mdified. If the parameter was nt mdified, the rw in the clumn fr the relevant parameter remains empty. If the parameter was mdified, an asterisk appears in the rw f the relevant parameter. HPE Universal CMDB (10.31) Page 155 f 300

156 Chapter 7: Package Manager This chapter includes: Package Administratin Overview 156 Package Zip File Cntents and Frmat 158 Packages fr Integratin Adapters 159 Cmpare and Merge Packages r Cntent Packs 159 Hw t Create a Custm Package 163 Hw t Deply a Package 164 Hw t Exprt a Package 165 Hw t Install a Discvery and Integratin Cntent Pack 166 Hw t Use the JMX Cnsle t Perfrm Package Manager Tasks 167 Package Resurces 170 Resurce Types 173 Package Manager User Interface 176 Trubleshting and Limitatins Package Manager 188 Package Administratin Overview A package cntains resurces that are gruped tgether by defined criteria. Fr a list f the default resurce types, see "Resurce Types" n page 173. Package Manager fulfills several functins: Enables the discvery f specific IT infrastructure assets. Fr example, Universal CMDB deplys the SQL_Server package t discver Micrsft SQL servers. Enables yu t define the CI Type mdel thrugh the CI types that are included in the packages. Fr example, sme f the CI types included in the Hst_Resurces_Basic package are File System, CPU, Prcess, and Print Queue. HPE Universal CMDB (10.31) Page 156 f 300

157 Chapter 7: Package Manager Enables yu t mve grups f resurces frm ne system t anther, fr example, frm a test t a prductin envirnment. There are tw types f packages: Factry package. Cntains resurces that are deplyed with the installatin and are used t initialize Universal CMDB. By default, factry packages are lcated in: C:\hp\UCMDB\UCMDBServer\cntent\basic_ packages. Nte: Sme f the factry packages that are deplyed with the installatin are nt visible in the list f packages that appear in Package Manager. T display the hidden packages, right-click anywhere n the Package Manager page and select Shw Hidden Packages. Custm package. A package that is user created. Yu may want t create a custm package if the factry packages d nt cntain the resurces needed fr the tl yu are develping, r if yu want t exprt resurces frm system t system. Fr details, see "Create Custm Package/Edit Package Wizard" n page 177. Cautin: If yu create custm packages fr the resurces r tls yu develp, d nt place them in the C:\hp\UCMDB\UCMDBServer\cntent\basic_packages flder. This flder is nly fr factry packages. Exprt and deplyment f packages frm system t system is perfrmed thrugh the Package Manager interface. Yu can: Exprt sme r all f a package's resurces t yur lcal directry. Fr details, see "Hw t Exprt a Package" n page 165. Deply sme r all f a package's resurces t the CMDB frm yur lcal directry. Fr details, see "Hw t Deply a Package" n page 164. Package Lcatins There are three pre-defined flders with ut-f-the-bx, autmatically deplyed packages under C:\hp\UCMDB\UCMDBServer\cntent: basic_packages. Cntains internal packages. adapters. Cntains adapter packages. HPE Universal CMDB (10.31) Page 157 f 300

158 Chapter 7: Package Manager cntent_packs. Cntains the latest Cntent Pack package CP_xx.zip (where xx represents Cntent Pack versin). Package Manager User Interface Each package in the Package Manager User Interface includes the fllwing: An Icn identifying the package as factry, hidden r user A Package Name representing the name f the.zip file (ptinal) The Categry as allcated in the descriptr.xml file (ptinal) A Readme file that crrespnds t the package (ptinal) The Versin f the package (ptinal) The Build Number f the package (ptinal) A Descriptin that crrespnds t the descriptin lcated in the descriptr.xml file Package Zip File Cntents and Frmat A package's resurces are stred in the CMDB. T exprt a package frm system t system, yu use the Package Manager interface (fr details, see "Package Manager Page" n page 183). Package Manager creates a zip file cntaining the resurces t enable the exprt f the resurces. When yu exprt resurces frm the Package Manager t yur lcal directry, the resurce definitins are stred in varius frmats, fr example, XML frmat. In the sample Netwrk.zip belw, the ruter.xml file cntains a Ruter CIT definitin and the Switch.xml file cntains a Switch CIT definitin. HPE Universal CMDB (10.31) Page 158 f 300

159 Chapter 7: Package Manager Packages fr Integratin Adapters Yu deply Integratin adapters by creating a package and placing them in the apprpriate flder. Fr details, see Add an Adapter fr a New External Data Surce in the HPE Universal CMDB Develper Reference Guide. Cmpare and Merge Packages r Cntent Packs This sectin includes: Overview 159 Cmpare and Merge 160 Hw t Merge Packages r Cntent Packs 162 Lg and Backup Files 162 Overview When yu deply packages r install a Cntent Pack, yu may want t retain yur custmized resurces separate frm the deplyed packages r installed Cntent Pack. Therefre, the functinalities f cmparing and merging packages r Cntent Packs are intrduced. Fr cnvenience, the fllwing terms are used in the dcument: HPE Universal CMDB (10.31) Page 159 f 300

160 Chapter 7: Package Manager INSTALLED: The ut-f-the-bx resurces frm the currently in-use Cntent Pack. CUSTOMIZED: Yur custmized resurces. NEW: The resurces t be deplyed frm the new Cntent Pack r packages. Cmpare and Merge This sectin describes the functinalities f cmparing and merging packages r Cntent Packs. Cmpare This functinality cmpares the files included in NEW with the same files included in CUSTOMIZED and INSTALLED, and then a reprt file upgrade_reprt.csv is generated t shw the cmparisn results, and a ZIP package backup.zip is generated t back up the resurces that are nt semantically equivalent. The reprt file upgrade_reprt.csv is under the <UCMDB_Server_Hme>/runtime/lg/package_ reprts/custmer_<custmerid>/cpupgrade/<timestamp> flder. The fllwing table describes clumns included in the upgrade_reprt.csv file and the default peratin t be taken by this functinality: Clumn Name Optins Descriptin Operatin Type - The resurce type - Name - The file name - Package - The new deplyed package name - Existence Status NEW The file nly exists in NEW. Use NEW CUSTOMIZED_ NEW The file exits in CUSTOMIZED and NEW but des nt exist in INSTALLED. Use NEW INSTALLED_NEW ALL The file exits in INSTALLED and NEW but des nt exist in CUSTOMIZED. The file exits in INSTALLED, NEW, and CUSTOMIZED. Use NEW G t Equality Status and cmpare HPE Universal CMDB (10.31) Page 160 f 300

161 Chapter 7: Package Manager Clumn Name Optins Descriptin Operatin Equality Status ALL_EQUAL INSTALLED, NEW, and CUSTOMIZED are all equal. Use NEW INSTALLED_ CUSTOMIZED_ EQUAL INSTALLED and CUSTOMIZED are semantically equal but different frm NEW. Use NEW INSTALLED_ NEW_EQUAL INSTALLED and NEW are semantically equal but different frm CUSTOMIZED. Use CUSTOMIZED CUSTOMIZED_ NEW_EQUAL CUSTOMIZED and NEW are semantically equal but different frm INSTALLED. Use NEW ALL_DIFFERENT INSTALLED, NEW, and CUSTOMIZED are all different. G t Merge Strategy and merge Merge Strategy USE_ CUSTOMIZED Use CUSTOMIZED Use CUSTOMIZED USE_NEW Use NEW Use NEW Final Strategy USE_ CUSTOMIZED Use CUSTOMIZED Use CUSTOMIZED USE_NEW Use NEW Use NEW Fr details abut the backup package, see "Lg and Backup Files" n the next page. Nte: The fllwing resurces are nt cmpared and cannt appear in the reprt and backup files because these resurces are merged by UCMDB: class cmdbview crrelatin discverycnfigfiles applicatinssignature.xml prtnumbertprtname.xml enrichment HPE Universal CMDB (10.31) Page 161 f 300

162 Chapter 7: Package Manager identificatin schedulerjb tql typedef validlinks Merge This functinality enables yu t use CUSTOMIZED r NEW. The default is using NEW. Hwever, yu can use CUSTOMIZED in the fllwing files nly if yu set Merge Packages/Cntent Pack t True in the Infrastructure Settings Manager: HardwareMappingCnfig.xml NATIpAddress.xml UriEndpintCnfiguratin.xml All files under the PrePstScripting flder Fr details abut the setting, see "Hw t Merge Packages r Cntent Packs" belw. Hw t Merge Packages r Cntent Packs T merge packages r Cntent Packs, d the fllwing: 1. In UCMDB, g t Administratin > Infrastructure Settings Manager. 2. Frm the Filter by clumn drp-dwn list, click Name, type Merge Packages/Cntent Pack in the text bx. 3. In the Value clumn, select True frm the drp-dwn list. 4. Click Save. Lg and Backup Files This sectin describes the files related t cmparing and merging packages r Cntent Packs. HPE Universal CMDB (10.31) Page 162 f 300

163 Chapter 7: Package Manager Lg file The mam.packaging.lg file under the <UCMDB_Server_Hme>/runtime/lg flder is enhanced t cntain the detailed lg infrmatin abut cmparing and merging packages r Cntent Packs. Fr the lg file t cntain the infrmatin that yu need, make sure that yu add the fllwing line t the <UCMDB_Server_Hme>/cnf/lg/mam.prperties file manually, as illustrated in the screensht: lg4j.categry.cm.hp.ucmdb.cpupgrade=${lglevel}, mam.packaging.appender Backup package The backup package backup.zip is under the <UCMDB_Server_Hme>/runtime/lg/package_ reprts/custmer_<custmerid>/cpupgrade/<timestamp> flder. If the Equality Status f a resurce is ALL_DIFFERENT, INSTALLED_NEW_EQUAL, r CUSTOMIZED_NEW_EQUAL, the resurce will be saved in backup.zip, except sme binary files, such as *.dll, and *.exe. The backup.zip package includes the fllwing flders where yu can find all the resurce types as sub flder names: Flder Name INSTALLED CUSTOMIZED NEW Descriptin Resurces that are backed up frm INSTALLED. Resurces that are backed up frm CUSTOMIZED. Resurces that are backed up frm NEW. Hw t Create a Custm Package When yu create a new package, yu give the package a unique name and descriptin, and then select the resurces yu want included in the package. Fr details, see "Create Custm Package/Edit Package Wizard" n page 177. HPE Universal CMDB (10.31) Page 163 f 300

164 Chapter 7: Package Manager Example f Resurces Selected t Be Included in a Package: The summary page in the Create Custm Package wizard displays the resurces selected t be included in the package, as shwn in the illustratin belw. The package cntains resurces frm the fllwing resurce grups: Relatinships Valid Links Cnfiguratin Item Types (CITs) Hw t Deply a Package Yu can deply sme r all f a package's resurces t the CMDB frm yur lcal directry. The package must be n yur lcal directry in rder t deply its resurces. T deply resurces frm packages n yur lcal directry: Nte: If yu want t retain yur custmized resurces separate frm the deplyed packages, see "Cmpare and Merge Packages r Cntent Packs" n page 159 fr details. 1. Click the buttn t pen the Deply Packages t Server dialg bx. 2. Click the buttn t pen the Deply Packages t Server (frm lcal disk) dialg bx. 3. Select a package zip file and click Open. The package appears in the upper pane f the dialg bx and its resurces appear in the lwer pane. HPE Universal CMDB (10.31) Page 164 f 300

165 Chapter 7: Package Manager 4. Select the resurces frm the package that yu want t deply. All the resurces are selected by default. 5. Optinally, select anther package zip file and select the relevant resurces t deply. 6. When yu have selected all the resurces yu want t deply frm each selected package, click Deply. 7. A status reprt appears indicating whether the deplyment was successful fr each resurce selected. Example f Deplying Only Specific Resurces in a Package: Yu want t deply nly sme f the resurces cntained in the package called ticket2.zip. Click the buttn. In the Deply Packages t Server dialg bx, click the buttn, brwse t the package's lcatin and select the resurces frm the package yu want t deply. See the fllwing illustratin: Nte: Every time a package related t a change in the class mdel is deplyed r undeplyed, a zip file is generated in the runtime\lg\package_reprts\custmer_1\classmdel flder. The zip file cntains the class mdel file befre the change, the class mdel file after the change, and the package deplyment reprt. Hw t Exprt a Package Yu can exprt sme r all f a package's resurces t yur lcal directry. Fr details, see "Package Manager Page" n page 183. Example f Exprting Only Specific Resurces in a Package: Yu want t exprt nly sme f the resurces cntained in a package called ticket2.zip t yur lcal directry. Click the buttn. In the Exprt Package dialg bx, select the Exprt Resurces ptin and select the resurces yu want t exprt. See the fllwing illustratin: HPE Universal CMDB (10.31) Page 165 f 300

166 Chapter 7: Package Manager Exprting User Permissins in a Package If yu want t exprt users frm yur UCMDB instance, alng with their permissins, t anther UCMDB instance, yu can create a custm package cntaining the users and rles and exprt the package t the required lcatin. The package must cntain the selected users, the rles that are assigned t them, and als the rle assignments (the assciatin between a user and a rle). Yu can select each f these entities in the Resurce Selectin tab f the Edit Package dialg bx, under Administratin. When yu select Rle Assignments in the left pane, all available cmbinatins f users and assigned rles are displayed in the right pane. If a user has mre than ne rle assigned, yu must include each rle and each rle assignment in the package, t retain the user's permissins. If the users and the rles already exist n the target UCMDB instance, yu can exprt a package cntaining nly the relevant rle assignments. Fr details n selecting resurces fr a package, see "Resurce Selectin Page" n page 178. Hw t Install a Discvery and Integratin Cntent Pack Universal CMDB is released tgether with the latest versin f Discvery and Integratin Cntent Pack. Yu can install a later Cntent Pack release by perfrming the fllwing prcedure: Nte: If yu want t retain yur custmized resurces separate frm the installed Cntent Pack, see "Cmpare and Merge Packages r Cntent Packs" n page 159 fr details. 1. If the required Cntent Pack is available n the lcal file system f the UCMDB server, access Package Manager: Administratin > Package Manager. Click Install Cntent Pack t pen the Install Cntent Pack dialg bx. Fr details, see "Package Manager Page" n page Select the Cntent Pack t install and click Install. 3. Answer OK t the message. UCMDB begins t install the Cntent Pack. HPE Universal CMDB (10.31) Page 166 f 300

167 Chapter 7: Package Manager When installatin is cmplete, a message is displayed with the results f the installatin. 4. If the required Cntent Pack is nt available n the UCMDB server, access it frm the HPE Live Netwrk site. T access the site: Data Flw Management > UD Cmmunity. 5. Dwnlad the zip file and extract it t the Universal CMDB Server rt flder. 6. In Package Manager, click Uplad Cntent Pack t uplad the Cntent Pack frm the lcal file system and install n the server. Hw t Use the JMX Cnsle t Perfrm Package Manager Tasks This sectin describes the Package Manager tasks yu can perfrm using the JMX cnsle. Nte: It is recmmended that yu use the Package Manager t perfrm these tasks instead f the JMX cnsle. View Package Deplyment Histry cannt be perfrmed by the Package Manager. This sectin includes the fllwing tasks: "Deply a Package" belw "View Package Deplyment Histry" n the next page "Undeply a Package" n the next page "Display Currently Deplyed Packages" n page 169 "Exprt Packages" n page 169 "Package Name Rules" n page 170 Deply a Package Fllw these steps t deply a package using the JMX cnsle. 1. Launch yur Web brwser and enter the fllwing address: where <server_name> is the name f the machine n which Universal CMDB is installed. HPE Universal CMDB (10.31) Page 167 f 300

168 Chapter 7: Package Manager 2. Under UCMDB, click UCMDB:service=Packaging Services t pen the JMX MBEAN View page. 3. Lcate deplypackages. 4. In the Value bx fr the parameter custmerid, enter the <custmer id>. 5. In the Value bx fr the parameter dir, enter the name f the flder that cntains the package's zip file. Ensure that yu include the full path t the flder. Nte: T deply the package frm the basic_packages directry, leave this bx empty. 6. In the Value bx fr the parameter packagesnames, enter the name f the packages. Fr details, see "Package Name Rules" n page Select True t verride jb cnfiguratins changed in Universal Discvery. Fr details, see "Discvery Mdules/Jbs Tab" in the HPE Universal CMDB Data Flw Management Guide. 8. Click Invke t deply the package. View Package Deplyment Histry Each time yu deply packages, a reprt is created displaying the deplyment status f thse packages. Use the JMX cnsle t view the deplyment status reprt. 1. Launch the Web brwser and navigate t: where <server_name> is the name f the machine n which Universal CMDB is installed. 2. Under UCMDB, click UCMDB:service=Packaging Services t pen the JMX MBEAN View page. 3. Lcate displayresurcesdeplymenthistry. 4. In the Value bx fr the parameter custmerid, enter the <custmer id>. 5. In the Value bx fr the parameter reprtnum, enter the number f the reprt yu want t view. 6. Click Invke t view the deplyment status reprt f the packages. Undeply a Package Fllw these steps t undeply a package using the JMX cnsle. 1. Launch the Web brwser and navigate t: where <server_name> is the name f the machine n which Universal CMDB is installed. HPE Universal CMDB (10.31) Page 168 f 300

169 Chapter 7: Package Manager 2. Under UCMDB, click UCMDB:service=Packaging Services t pen the JMX MBEAN View page. 3. Lcate undeplypackages. 4. In the Value bx fr the parameter custmerid, enter the <custmer id>. 5. In the Value bx fr the parameter packagesnames, enter the name f the package yu want t remve. Fr details, see "Package Name Rules" n the next page. 6. Click Invke t undeply the package. Display Currently Deplyed Packages Fllw these steps t display currently deplyed packages using the JMX cnsle. 1. Launch the Web brwser and navigate t: where <server_name> is the name f the machine n which Universal CMDB is installed. 2. Under UCMDB, click UCMDB:service=Packaging Services t pen the JMX MBEAN View page. 3. Lcate displaydeplyedpackages. 4. In the Value bx fr the parameter custmerid, enter the <custmer id>. 5. In the Value bx fr the parameter packagesnames, specify the names f the packages yu want t display. Fr details, see "Package Name Rules" n the next page. 6. Click Invke t display the packages that are currently deplyed. Exprt Packages Fllw these steps t exprt resurces frm the CMDB t the server n which Universal CMDB is installed using the JMX cnsle. 1. Launch the Web brwser and navigate t: where <server_name> is the name f the machine n which Universal CMDB is installed. 2. Under UCMDB, click UCMDB:service=Packaging Services t pen the JMX MBEAN View page. 3. Lcate exprtpackages. 4. In the Value bx fr the parameter custmerid, enter the <custmer id>. HPE Universal CMDB (10.31) Page 169 f 300

170 Chapter 7: Package Manager 5. In the Value bx fr the parameter packagesname, enter the name f the package yu want t exprt. Fr details, see "Package Name Rules" belw. 6. In the Value bx fr the parameter utputdir, enter the name f the flder n the Universal CMDB server t which yu want t exprt the package's zip file. Ensure that yu include the full path t the flder. 7. In the Value bx fr the parameter useronly, select ne f the fllwing: True. Exprt nly the custm packages. False. Exprt bth custm and factry packages. 8. Click Invke t exprt the package. Package Name Rules The rules fr entering a package name are as fllws: Wildcard characters (*) are nt supprted. The package name is case sensitive. The package name must have a.zip extensin. When deplying mre than ne package, separate the package names by cmmas. Package Resurces This sectin cntains a list f the resurces a package can cntain. Fr a list f the available resurce types and their descriptins, see "Resurce Types" n page 173. acl. The definitin f a rle such as Administratr r Guest. Fr details, see "Rles Manager" n page 259. adapter. Cntains a descriptin and the capabilities f the deplyed federated adapter. adaptercde. Cntains cmpiled classes (nrmally a jar), based-n *.jar files, and cnfiguratin files needed fr federated adapters. Place these files in the adaptercde\<adapter ID> flder in the zip package. Fr details, see "Add an Adapter fr a New External Data Surce" in the HPE Universal CMDB Develper Reference Guide. calculatedlinks. Cntains the calculated super class fr each f the calculated links defined. calculatedlinkstriplets. Cntains the calculated relatinships and their triplets as defined in the CI HPE Universal CMDB (10.31) Page 170 f 300

171 Chapter 7: Package Manager Type Manager. categries. Cntains the State definitins used by Impact Analysis. Fr details n States, see "State Manager" n page 190. Fr details n Impact Analysis, see "Impact Analysis Manager" in the HPE Universal CMDB Mdeling Guide. class. CI type descriptins, such as hst, file, switch, and s n. Fr details, see "CI Type Manager" in the HPE Universal CMDB Mdeling Guide. cmdbview. Cntains the hierarchy rules defined fr the base TQL query f each view. Fr details, see "Mdeling Studi" in the HPE Universal CMDB Mdeling Guide. crrelatin. Impact rule definitins. Fr details, see "Impact Analysis Manager" in the HPE Universal CMDB Mdeling Guide. datamdel. Used t imprt CI instances int the system. If the CI des nt exist in the CMDB, an instance f the CI is created. If a CI already exists in the CMDB, the values f the CI frm the package resurce verwrites the values f the CI in the CMDB. datamdelcreatenly. Used t imprt CI instances int the system. If the CI des nt exist in the CMDB, an instance f the CI is created. If a CI already exists in the CMDB, the values f the CI frm the package resurce des nt verwrite the values f the CI in the CMDB. datamdelgenerateids. Used t imprt CI instances int the system fr CITs that require the ID t be calculated dynamically upn deplyment (such as CITs with n key attributes). datastre. Cntains the integratin pint defintin. discverycnfigfiles. Cnfiguratin files include prperties and parameters that are needed t discver cmpnents n the system. Fr details, see "Adapter Cnfiguratin" in the HPE Universal CMDB Data Flw Management Guide. discveryjbs. A Data Flw Management (DFM) jb includes cnfiguratin data, scheduling infrmatin, and TQL assignments needed t activate discvery f cmpnents. Fr details, see "Intrductin t Universal Discvery" in the HPE Universal CMDB Data Flw Management Guide. discverymdules. A DFM mdule includes all the jbs needed t discver a specific cmpnent in the system. Fr details, see "Intrductin t Universal Discvery" in the HPE Universal CMDB Data Flw Management Guide. discverypatterns. DFM adapters define which cde t run and in which rder, declare the input and utput CI Types and parameters t be cnfigurable n the DFM jbs related t them. The adapater can be used as an integratin adapter r a Discvery adapter. Fr details, see "Adapter Cnfiguratin" in the HPE Universal CMDB Data Flw Management Guide. discveryresurces. External resurces include all external resurces that are needed in DFM, HPE Universal CMDB (10.31) Page 171 f 300

172 Chapter 7: Package Manager fr example, a Visual Basic file, an additinal jars file, and s n. Fr details, see "Adapter Cnfiguratin" in the HPE Universal CMDB Data Flw Management Guide. discveryscripts. DFM Jythn scripts ppulates the CMDB with data, either by perfrming Discvery n a netwrk cmpnent r during integratin with an external data repsitry. Fr details, see "Adapter Cnfiguratin" in the HPE Universal CMDB Data Flw Management Guide. discverywizard. Used t define the Discvery Activity dialg bx cntents. Fr details, see the sectin n discvery activities in the HPE Universal CMDB Discvery and Integratins Cntent Guide. dcs. Cntains dcument fr the package (if applicable). dynamicsettings. The dynamicsettings package cntains a list f settings which are specific fr the UCMDB Brwser. The package is deplyed by the UCMDB Brwser at startup time. enrichment. Enrichment rule definitins. Fr details, see "Enrichment Manager" in the HPE Universal CMDB Mdeling Guide. identificatin. Cntains the identificatin definitin f a specific CI type. integratinusers. Used t define a user f type integratin. mdelntificatin. Cntains filter definitins fr CMDB mdel ntificatins. The data mdel ntificatin system gives ntificatin f changes that ccurred in the CMDB. Fr example, items in the CMDB that have been remved, updated, r added. reprt. Reprt rule definitins, as described in "Tplgy Reprts Overview" in the HPE Universal CMDB Mdeling Guide. schedulerjb. Tasks that have been defined t run in the Scheduler. Fr details, see "Scheduler" n page 193. singletqlref. Cntains TQL template and perspective instances. Fr details, see "Mdeling Studi" in the HPE Universal CMDB Mdeling Guide. tql. TQL query definitins. Fr details, see "Tplgy Query Language (TQL) Overview" in the HPE Universal CMDB Mdeling Guide. typedef. Predefined Enumeratin definitins that relate t attributes f type Enumeratin, such as severity levels, admin states, and s n. Fr details, see "System Type Manager" in the HPE Universal CMDB Mdeling Guide. urm. Resurces f a Dynamic Widget, which gets deplyed by the UCMDB Brwser at startup time. users. The definitin f a user and the user's rle. Fr details, see "Users and Grups" n page 244. HPE Universal CMDB (10.31) Page 172 f 300

173 Chapter 7: Package Manager validlinks. All predefined, valid cnnectins (relatinships) between CITs. Resurce Types This sectin cntains a list f the available resurce types and their descriptins. Fr a list f the resurces a package can cntain, see "Package Resurces" n page 170. Mdel Cnfiguratin Item Types. The CITs defined in the CI Type Manager. Fr details, see "CI Types Overview" in the HPE Universal CMDB Mdeling Guide. Identificatins. The cnfiguratin files cntaining the identificatin rules fr CIs. Fr details, see "Identificatin Service" in the HPE Universal CMDB Data Flw Management Guide. Relatinships. The relatinships defined in the CI Type Manager. Fr details, see "CI Type Relatinships" in the HPE Universal CMDB Mdeling Guide. Calculated Relatinships. Cntains the calculated relatinships and their triplets as defined in the CI Type Manager. Valid Links. All pssible predefined valid cnnectins (relatinships) between the CITs that are defined in the CIT flder. Service Mdels. The pattern-based mdels defined in the Mdeling Studi that were nt defined ver an existing mdel. Fr details, see "Pattern-based Mdels" in the HPE Universal CMDB Mdeling Guide. Query Queries. The TQL queries defined in the TQL Editr in the Mdeling Studi. Fr details, see "Tplgy Query Language" in the HPE Universal CMDB Mdeling Guide. Views. The views defined in the View Editr in the Mdeling Studi. Fr details, see "View Frmats" in the HPE Universal CMDB Mdeling Guide. Enrichments. The Enrichment rules defined in the Enrichment Manager. Fr details, see "Enrichment Manager" in the HPE Universal CMDB Mdeling Guide. Impact Rules. The Impact Analysis rules. Fr details, see "Impact Analysis Manager" in the HPE HPE Universal CMDB (10.31) Page 173 f 300

174 Chapter 7: Package Manager Universal CMDB Mdeling Guide. Plicies. The plicies used in HPE Universal CMDB Cnfiguratin Manager. Fr details, see "Plicies" in the HPE Universal CMDB Cnfiguratin Manager User Guide. Settings Type Definitins. Predefined Enumeratin definitins that relate t attributes f enumeratin type, such as severity levels, admin states, and s n. Fr details, see "System Type Manager" in the HPE Universal CMDB Mdeling Guide. Jb Scheduler. Tasks that have been defined t run in the Scheduler. Fr details, see "Scheduler" n page 193. State Categries. The states defined in the State Manager. Fr details, see "State Manager" n page 190. Discvery Adapters. DFM adapters define which scripts need t be run and in which rder, declare the input and utput CI Types and the parameters t be cnfigurable n the Discvery jbs related t them. Fr details, see "Adapter Cnfiguratin" in the HPE Universal CMDB Data Flw Management Guide. Discvery Dcuments. A Discvery dcument is a custmized dcument describing the usage and functinality f a specific package. Fr details, see "Hw t Attach Discvery Dcumentatin t a Discvery Package" in the HPE Universal CMDB Data Flw Management Guide. Discvery Mdules. A Discvery mdule includes all the jbs needed t discver a specific cmpnent n the system. Fr details, see "Discvery Mdules/Jbs - Discvery Mdules Pane" in the HPE Universal CMDB Data Flw Management Guide. Discvery Jbs. A Discvery jb includes cnfiguratin data, scheduling infrmatin, and TQL assignments needed t activate discvery f cmpnents. Fr details, see "Intrductin t Universal Discvery" in the HPE Universal CMDB Data Flw Management Guide. Discvery Cnfiguratin Files. Cnfiguratin files include prperties and parameters that are needed t discver cmpnents n the system. Fr details, see "Hw t Define Discvery Rules" in the HPE Universal CMDB Data Flw Management Guide. Discvery Jythn Script. Discvery Jythn Scripts are Jythn scripts used by the discvery prcess t discver and map the varius netwrk entities. HPE Universal CMDB (10.31) Page 174 f 300

175 Chapter 7: Package Manager Discvery External Resurce. Includes resurces nt used by the Data Flw Prbe directly, but rather indirectly by the DFM scripts. It can cntain binary executable files r DLLs, XML cnfiguratin files, r any ther essential resurce needed fr the discvery t functin prperly. Fr details, see "Adapter Cnfiguratin" in the HPE Universal CMDB Data Flw Management Guide. Discvery Wizard Resurce. Used t define the Discvery Activity dialg bx cntents. Fr details, see the sectin n discvery activities in the HPE Universal CMDB Discvery and Integratins Cntent Guide. Sftware Applicatin Library. Cntains sftware applicatin and versin descriptins that are used t identify files that are discvered during the inventry discvery prcess. Fr details, see the Sftware Applicatin Index sectin in the HPE Universal CMDB Discvery and Integratins Cntent Guide. Inventry Scanner Cnfiguratin. Cnfiguratin settings that cntrl hw inventry is cllected, which infrmatin is gathered, and the level f detail t be included. Fr details, see the sectin n the Scanner Generatr in the HPE Universal CMDB Discvery and Integratins Cntent Guide. Scanner Package fr Scanner Generatr. The base file used by the Scanner Generatr t build a manually-deplyed executable scanner file. Fr details, see the sectin n the Scanner Generatr in the HPE Universal CMDB Discvery and Integratins Cntent Guide. Service Discvery Activity Type. Defines jbs used by service discvery and their trigger TQL queries as well as default jb parameters. Fr details, see the sectin n "Service Discvery " in the HPE Universal CMDB Data Flw Management Guide and als the sectin n "Service Mdeling" in the HPE Universal CMDB Brwser Installatin and Cnfiguratin Guide. Service Discvery Activity Template. Specifies parameter verrides fr selected jbs f the Service Discvery activity. Fr details, see the sectin n "Service Discvery " in the HPE Universal CMDB Data Flw Management Guide. Administratin Users. The users defined in the Users and Grups mdule. Fr details, see "Users and Grups" n page 244. User Grups. The user grups defined in the Users and Grups mdule. Fr details, see "Users and Grups" n page 244. Resurce Grups. The resurce grups defined in the Resurce Grups mdule. Fr details, see "Resurce Grups" n page 275. Rles. The rles defined in the Rles Manager mdule t assign permissins t users. Fr details, HPE Universal CMDB (10.31) Page 175 f 300

176 Chapter 7: Package Manager see "Rles Manager" n page 259. Tenants. The tenants added in the Tenants Management mdule. Fr details, see "Tenants Management" n page 290. (Only available when multi-tenancy is enabled.) Rle Assignments. The rle assignments t users defined in the Users and Grups mdule. Fr details, see "Users and Grups" n page 244. Miscellaneus Miscellaneus. Cntains miscellaneus resurces. Package Manager User Interface This sectin includes (in alphabetical rder): Chse Resurces t Exprt Dialg Bx 176 Create Custm Package/Edit Package Wizard 177 Exprt Package Dialg Bx 180 Filter Dialg Bx 181 Find Dialg Bx 182 Package Manager Page 183 Undeply Package Resurce Wizard 187 Chse Resurces t Exprt Dialg Bx This dialg bx enables yu t exprt an entire package r specific resurces t yur lcal directry. T access Click the Exprt resurces buttn in the Exprt Package dialg bx. User interface elements are described belw (unlabeled elements are shwn in angle brackets): UI Element (A-Z) <List f resurces > Descriptin Displays the list f resurces cntained in the package. Select the resurces yu want t exprt t yur lcal directry. HPE Universal CMDB (10.31) Page 176 f 300

177 Chapter 7: Package Manager Create Custm Package/Edit Package Wizard This wizard enables yu t create a package using existing resurces r edit an existing package. T access D ne f the fllwing: Click the Create custm package buttn n the Package Manager page t create a new package. Select a package and click the Edit package buttn t edit an existing package. Imprtant infrmatin Relevant tasks Wizard map When editing an existing package, this feature is nt a wizard, but a dialg bx. The dialg bx cntains tw tabs: the Package Prperties tab and the Resurce Selectin tab. "Hw t Create a Custm Package" n page 163 The "Create Custm Package/Edit Package Wizard" cntains: "Package Prperties Page" > "Resurce Selectin Page" > "Selectin Summary Page" See als "Package Administratin Overview" n page 156 "Package Resurces" n page 170 "Resurce Types" n page 173 Package Prperties Page This wizard page enables yu t define the prperties f the package. Wizard map The "Create Custm Package/Edit Package Wizard" cntains: "Package Prperties Page" > "Resurce Selectin Page" > "Selectin Summary Page" User interface elements are described belw: UI Element (A-Z) Package Build Number Descriptin The build number f the package. HPE Universal CMDB (10.31) Page 177 f 300

178 Chapter 7: Package Manager UI Element (A-Z) Package Categry Package Descriptin Package Name Descriptin A free text bx fr any ntes yu want t assciate with the package. A descriptin f the package. The name f the package. Resurce Selectin Page This wizard page enables yu t add the required resurces t the package. Select the required resurces frm the varius resurce types. Imprtant infrmatin Wizard map Yu can make multiple selectins frm each resurce type. The "Create Custm Package/Edit Package Wizard" cntains: "Package Prperties Page" > "Resurce Selectin Page" > "Selectin Summary Page" User interface elements are described belw (unlabeled elements are shwn in angle brackets): UI Element (A-Z) Autmatically exprt dependencies f the checked resurces Descriptin (Create Custm Package Wizard nly) Select this check bx allws yu t autmatically exprt dependencies f the checked resurces when creating a package. Appears in the left pane. Indicates that a resurce has been added t the package. Appears in the left pane. Indicates that n resurce has been added t the package. <Resurce types in the left pane> Cntains the resurce types frm which yu can chse the required resurces t add t the package. Fr details f a list f the available resurce types and their descriptins, see "Resurce Types" n page 173. Nte: A green dt appears n the resurce type icn in the right pane, when HPE Universal CMDB (10.31) Page 178 f 300

179 Chapter 7: Package Manager UI Element (A-Z) Descriptin ne r mre f its resurces are selected t be included in the package. <Resurces in the right pane> Select the resurces yu want t add t the package. Yu can select multiple resurces. Nte: A green check appears t the right f a Cnfiguratin Item Types, Relatinships, r Calculated Relatinships when ne r mre f its children in the resurce tree are included in the package. A flder's check bx has a when nly sme f its resurces are included in the package. (This des nt apply t Cnfiguratin Item Types, Relatinships, r Calculated Relatinships.) A flder's check bx is selected when all its resurces are included in the package. (This des nt apply t Cnfiguratin Item Types, Relatinships, r Calculated Relatinships.) Imprtant infrmatin: T add a calculated relatinship t the package, select either the required calculated relatinship tgether with ne r mre f its triplets, r the required triplets withut selecting the calculated relatinship itself. If yu select nly specified triplets and nt the calculated relatinship, the triplets are added nly if yu already have an existing calculated relatinship in the system. If yu select a calculated relatinship tgether with ne r mre f its triplets, the prperty definitins f the calculated relatinship are included in the package. If yu already have a calculated relatinship in the system, the prperty definitins f the existing calculated relatinship are updated with the prperties f the calculated relatinship yu are adding t the package. Fr details n calculated relatinships and triplets, see "Using Calculated Relatinships" and "Triplets Page" in the HPE Universal CMDB Mdeling Guide. HPE Universal CMDB (10.31) Page 179 f 300

180 Chapter 7: Package Manager Selectin Summary Page This wizard page enables yu t view the resurces t be included in the package. Wizard map The "Create Custm Package/Edit Package Wizard" cntains: "Package Prperties Page" > "Resurce Selectin Page" > "Selectin Summary Page" User interface elements are described belw (unlabeled elements are shwn in angle brackets): UI Element (A-Z) <Selected resurces> Descriptin Displays the resurces that were selected t be part f the package. Exprt Package Dialg Bx This dialg bx enables yu t exprt the selected package's resurces t yur lcal directry. T access Click the Exprt package t lcal directry buttn n the Package Manager page. Imprtant infrmatin Yu can chse t exprt sme r all the resurces in the package. Relevant tasks "Hw t Exprt a Package" n page 165 See als "Package Administratin Overview" n page 156 User interface elements are described belw: UI Element (A- Z) Descriptin Exprt resurces Exprt t directry Exprt whle package Exprt nly sme f the package's resurces t yur lcal directry. Opens the Chse Resurces t Exprt dialg bx. Select the directry t which yu want t exprt the resurces. Exprt all the resurces in the package t yur lcal directry. HPE Universal CMDB (10.31) Page 180 f 300

181 Chapter 7: Package Manager UI Element (A- Z) Descriptin File name The name f the package. Nte: The package name cannt be edited. Filter Dialg Bx This dialg bx enables yu t display nly specific packages n the Package Manager page. T access Click the Filter buttn n the Package Manager page. Imprtant infrmatin A descriptin f the filter cnditin yu defined appears abve the table clumns n the Package Manager page. Fr example, the fllwing illustratin shws that a filter cnditin was created t display a package called Netwrk. See als "Package Administratin Overview" n page 156 User interface elements are described belw (unlabeled elements are shwn in angle brackets): UI Element (A- Z) Descriptin <Click a clumn header> <Right-click a clumn header> Cnditin Display Name Fr details, see "Srt Clumn Cntent Dialg Bx" in the HPE Universal CMDB Mdeling Guide. Fr details, see "Srt Clumn Cntent Dialg Bx" in the HPE Universal CMDB Mdeling Guide. Click inside the bx and select the required peratr. Fr details, see "Attribute Operatr Definitins" in the HPE Universal CMDB Mdeling Guide. Filter the task list accrding t ne f the fllwing: Package name Categry Readme Versin Build Number HPE Universal CMDB (10.31) Page 181 f 300

182 Chapter 7: Package Manager UI Element (A- Z) Descriptin Descriptin Fr details, see "Package Manager Page" n the next page. Value Click inside the bx t pen the Edit bx. Enter the required value. Nte: Yu must chse a value in the Cnditin clumn (ther than Is null r Nt null) t be able t specify a value fr the filter. When using the Like r Like ignre case peratrs, include the wildcard (%) in the search value. Find Dialg Bx This dialg bx enables yu t find a package that cntains a specified resurce. T access Click the Find buttn n the Package Manager page. See als "Resurce Types" n page 173 User interface elements are described belw: UI Element (A-Z) Case sensitive Resurce name Search Results Tpic Descriptin Distinguish between uppercase and lwercase characters. When yu select Case sensitive, search results find nly thse instances in which the capitalizatin matches the text yu typed in the Resurce name bx. Enter a wrd r phrase cntained in the resurce fr which yu are lking. The search results. Displays the names f up t 30 resurces cntaining the text entered in the Resurce name bx. The subsysytem cntaining the resurce yu want the package t cntain. Fr details, see "Resurce Types" n page 173. HPE Universal CMDB (10.31) Page 182 f 300

183 Chapter 7: Package Manager Package Manager Page This page enables yu t create a package ut f existing resurces r edit an existing package t suit yur IT management needs. T access Relevant tasks Select Package Manager frm the Administratin mdule n the Navigatin Menu r select Managers > Administratin > Package Manager. "Hw t Deply a Package" n page 164 "Hw t Exprt a Package" n page 165 "Hw t Create a Custm Package" n page 163 "Hw t Install a Discvery and Integratin Cntent Pack" n page 166 See als "Package Administratin Overview" n page 156 "Package Resurces" n page 170 "Resurce Types" n page 173 User interface elements are described belw: UI Element (A-Z) Descriptin Create custm package. Enables yu t create a package ut f existing resurces. Opens the Create Custm Package Wizard. Fr details, see "Hw t Create a Custm Package" n page 163. Edit package. Enables yu t edit an existing package. Opens the Edit Package Wizard. Delete. Deletes a package frm the Package Manager while the resurces frm the package remain in the system. The package that is deleted is remved frm the list f packages n the Package Manager page. View package resurces. Enables yu t view the resurces included in the selected package. Opens the View package resurces dialg bx. Exprt package table. Enables yu t generate a reprt displaying a list f the packages that are deplyed in the system. Chse the exprt frmat fr the table data. The available ptins are: CSV. The table data is frmatted as a cmma-separated values (CSV) text file HPE Universal CMDB (10.31) Page 183 f 300

184 Chapter 7: Package Manager UI Element (A-Z) Descriptin that can be displayed in a spreadsheet. Nte: Fr the CSV frmatted table data t display crrectly, the cmma (,) must be defined as the list separatr. In Windws, t verify r mdify the list separatr value, pen Reginal Optins frm the Cntrl Panel, and n the Numbers tab ensure that the cmma is defined as the List Separatr value. In Linux, yu can specify the list separatr in the applicatin that pens the CSV file. PDF. The table data is exprted in PDF frmat. Nte: When exprting t PDF, select a reasnable number f clumns t display t ensure that the reprt is legible. XLS.. The table data is frmatted as an Excel (.xls) file that can be displayed in a spreadsheet. XML. The table data is frmatted as an XML file that can be pened in a text r XML editr. Tip: T extract HTML cde frm the reprt: Save the file as HTML Open the file in an HTML editr Cpy the relevant table int the target file Deply packages t server. Deplys a package's resurces t the CMDB frm yur lcal directry. In the upper pane, click the buttn t pen the Deply Packages t Server dialg bx. Brwse t the required package. The resurces frm that package appear in the lwer pane f the dialg bx. Select the resurces that yu want t deply. Nte: When deplyment is finished and it is nt successful, a Deply Package dialg bx is displayed indicating which resurces within the package are nt successfully deplyed. Undeply resurces. Deletes the resurces frm the system and remves them frm the selected package. Opens the Undeply Package Resurce Wizard. Exprt package t lcal directry. Exprts sme r all f the package's resurces HPE Universal CMDB (10.31) Page 184 f 300

185 Chapter 7: Package Manager UI Element (A-Z) Descriptin t yur lcal directry. Opens the Exprt package dialg bx. Find. Enables yu t search fr a package that cntains a specified resurce. Opens the Find dialg bx. Refresh. Refreshes the cntents f the table. Install Cntent Pack. Enables yu t install the latest Discvery and Integratin Cntent Pack frm the lcal file system. This buttn is enabled frm Cntent Pack 7.00 nwards. Fr details, see "Hw t Install a Discvery and Integratin Cntent Pack" n page 166. Nte: This feature is nly relevant when the latest cntent pack is available in the lcal file system f the UCMDB Server. Uplad Cntent Pack. Enables yu t uplad and install a Discvery and Integratin Cntent Pack. In the Uplad and Install Cntent Pack dialg bx, select the required cntent pack frm yur lcal file system t uplad and install n the server. Nte: Editing the Cntent Pack file using 7-Zip may result in the file being saved with an incrrect versin. View UCMDB Class Mdel. Opens the UCMDB Class Mdel Reference, which cntains infrmatin n all packages, CI types and relatinships in the class mdel. Filter. Opens the Filter dialg bx. Yu use the Filter dialg bx t shw nly the packages yu want displayed n the Package Manager page. Clear. Clears the filter definitins yu created in the Filter dialg bx. This is enabled nly if filter definitins were created. Custmize Clumns. Opens the Select Clumns dialg bx where yu can change the display rder f the clumns, hide a clumn, r display a hidden clumn. Fr details n the Select Clumns dialg bx, see Select Clumns Dialg Bx in the HPE Universal CMDB Mdeling Guide. Represents a factry package. Represents a hidden package. HPE Universal CMDB (10.31) Page 185 f 300

186 Chapter 7: Package Manager UI Element (A-Z) Descriptin Represents a custm package. Build Number Categry Descriptin Package Name Readme Versin The build number f the package. The free text yu want t assciate with the package, as displayed n the Package Prperties page f the Create Custm Package Wizard. The descriptin f the package, as displayed n the Package Prperties page f the Create Custm Package Wizard. The name f the package. Click t read a descriptin f the package, as well as ther relevant infrmatin. The versin f the package. Shrtcut Menu Menu Item Delete Edit Exprt Package Shw hidden packages Undeply View package Descriptin Deletes a package frm the Package Manager while the resurces frm the package remain in the system. The package that is deleted is remved frm the list f packages n the Package Manager page. Edit the selected package. Opens the Edit Package Wizard. Exprts sme r all f the package's resurces t yur lcal directry. Opens the Exprt Package dialg bx. Tggle between displaying and hiding hidden packages. Deletes the resurces frm the system and remves them frm the selected package. Opens the Undeply Package Resurce Wizard. View the resurces included in the selected package. Opens the View package resurces dialg bx. HPE Universal CMDB (10.31) Page 186 f 300

187 Chapter 7: Package Manager Menu Item Descriptin resurces Undeply Package Resurce Wizard This wizard deletes the resurces frm the system and remves them frm the selected package. T access Click the Undeply resurces buttn n the Package Manager page. Imprtant infrmatin Wizard map When yu undeply a package, the resurces are remved frm the system, and frm the ther packages that cntain that resurce. Yu can restre the resurces nly when a package cntaining thse resurces is deplyed. The "Undeply Package Resurce Wizard" cntains: "Remve Resurces Page" > "Selectin Summary Page" See als "Package Administratin Overview" n page 156 "Hw t Use the JMX Cnsle t Perfrm Package Manager Tasks" n page 167 Remve Resurces Page This wizard page enables yu t select the resurces yu want t delete. Imprtant infrmatin Wizard map If yu delete all the resurces frm the package, the package is autmatically deleted and remved frm the list f packages n the Package Manager page. The "Undeply Package Resurce Wizard" cntains: "Remve Resurces Page" > "Selectin Summary Page" User interface elements are described belw (unlabeled elements are shwn in angle brackets): UI Element (A-Z) <List f resurces cntained in the selected package> Descriptin Displays the resurces cntained in the selected package. Select the resurces yu want t delete frm the system. HPE Universal CMDB (10.31) Page 187 f 300

188 Chapter 7: Package Manager Selectin Summary Page This wizard page enables yu t view the resurces yu selected t be deleted. Imprtant infrmatin Wizard map When undeplyment is finished and it is nt successful, an Undeply Package dialg bx is displayed indicating which resurces within the package are nt successfully undeplyed. The "Undeply Package Resurce Wizard" cntains: "Remve Resurces Page" > "Selectin Summary Page" User interface elements are described belw (unlabeled elements are shwn in angle brackets): UI Element (A-Z) <List f deleted resurces> Descriptin Displays the resurces that were selected t be deleted frm the package. Trubleshting and Limitatins Package Manager This sectin describes sme f the trubleshting issues that might arise when deplying and undeplying packages. This sectin includes the fllwing tpics: "Gld Master Reprts Cannt be Deplyed by Package Manager" belw "Datamdel Resurces Cannt Be Undeplyed" n the next page "Additinal Infrmatin n Package Deplyment Failure" n the next page "Package Creatin and Deplyment in a Nn-English Lcale" n the next page Gld Master Reprts Cannt be Deplyed by Package Manager If yu exprt a package's resurces frm Package Manager that includes a Gld Master reprt definitin, and then exprt thse resurces again t anther system, the Gld Master reprt definitin is nt deplyed. HPE Universal CMDB (10.31) Page 188 f 300

189 Chapter 7: Package Manager Datamdel Resurces Cannt Be Undeplyed Fr a list f the package resurces, see "Package Resurces" n page 170. Additinal Infrmatin n Package Deplyment Failure If package deplyment fails, yu can check the Package Manager lg files fr additinal infrmatin n why the deplyment failure ccurred. Lg files are lcated in the C:\hp\UCMDB\UCMDBServer\runtime\lg flder. Package Creatin and Deplyment in a Nn-English Lcale This sectin describes the limitatins when wrking in a nn-english lcale. Yu cannt deply a package if the server lcale is different than the client lcale and the package name cntains nn-english characters. Yu cannt create a package that cntains resurces (fr example, views and TQL queries) having nn-english characters in their names, if the server lcale is different frm the client lcale. HPE Universal CMDB (10.31) Page 189 f 300

190 Chapter 8: State Manager This chapter includes: State Manager Overview 190 Hw t Define a State 190 State Manager User Interface 191 State Manager Overview A state is based n a severity list called an Enumeratin definitin. States are necessary fr retrieving Impact Analysis results in IT Universe Manager. Fr details, see "IT Universe Manager" in the HPE Universal CMDB Mdeling Guide. T retrieve Impact Analysis results, yu must create an Impact Analysis rule in Impact Analysis Manager, which is based n the Operatin state. Fr details, see "Impact Analysis Manager" in the HPE Universal CMDB Mdeling Guide. State Manager cntains tw default states Change and Operatin. Each ne is based n its wn severity list. Yu can use nly the Operatin state t retrieve Impact Analysis results in IT Universe Manager. Nte: It is nt recmmended t define states withut first cnsulting HPE Sftware Supprt. Hw t Define a State 1. Click the Add state buttn and enter a unique name and descriptin fr the state. 2. Click inside the Type Definitin clumn t select the required Enumeratin definitin. The Type Definitin list displays the Enumeratin definitins that are defined in System Type Manager. Fr details, see "System Type Manager Dialg Bx" in the HPE Universal CMDB Mdeling Guide. 3. (Optinal) Yu can create a new Enumeratin definitin by clicking the New Enumeratin buttn. Fr details, see "State Manager Page" n the next page. HPE Universal CMDB (10.31) Page 190 f 300

191 Chapter 8: State Manager Nte: Only the Enumeratin definitins whse list f key values begins with zer (0) appear in the State Manager. Alternatively, yu can create an Enumeratin definitin in System Type Manager. The Enumeratin definitin yu create in System Type Manager appears in State Manager. State Manager User Interface This sectin includes: State Manager Page 191 State Manager Page This page enables yu t create a state based n a severity list (Enumeratin definitin). T access Imprtant infrmatin Select State Manager frm the Administratin mdule n the Navigatin Menu r select Managers > Administratin > State Manager. The change and peratin states are default states that cannt be edited. It is recmmended t cnsult with HPE Sftware Supprt befre defining a state. Relevant tasks "Hw t Define a State" n the previus page See als "State Manager Overview" n the previus page Hw t Create an Enumeratin Definitin Wrkflw in the HPE Universal CMDB Mdeling Guide User interface elements are described belw: UI Element (A-Z) Descriptin Add state. Enables yu t add a state. Delete state. Deletes the selected state. HPE Universal CMDB (10.31) Page 191 f 300

192 Chapter 8: State Manager UI Element (A-Z) Descriptin Saves the changes yu have made. Creates an Enumeratin definitin. Opens the Create Enumeratin Definitin dialg bx. Fr details, see Create/Update List/Enumeratin Definitin Dialg Bx in the HPE Universal CMDB Mdeling Guide. The Enumeratin definitin yu have created appears in the System Type Manager dialg bx, where yu can edit it if required (fr details, see System Type Manager Dialg Bx in the HPE Universal CMDB Mdeling Guide. Descriptin Name Type Definitin (Optinal) Click in the bx and enter a descriptin f the state. Click in the bx and enter a unique name fr the state. Click in the bx t display a list f the Enumeratin definitins. Nte: The Type Definitin list nly displays the Enumeratin definitins whse list f key values begins with zer (0) (and nt List definitins) that are defined in the System Type Manager. HPE Universal CMDB (10.31) Page 192 f 300

193 Chapter 9: Scheduler This chapter includes: Hw t Define Tasks That Are Activated n a Peridic Basis 193 Hw t Rebuild Indexes n Micrsft SQL Databases 195 Scheduler User Interface 196 Hw t Define Tasks That Are Activated n a Peridic Basis This task describes hw t run jbs n a peridic basis. This sectin includes the fllwing tasks: "Create a Jb Definitin" belw "Chse an Actin" belw "Schedule a Task" n the next page 1. Create a Jb Definitin Define a jb definitin. Add actins t the jb yu created and define hw ften they run. The Jb Definitin dialg bx displays the tasks that are defined. Fr details, see "Jb Definitin Dialg Bx" n page 198. Example f a Jb Definitin The illustratin belw shws that an Enrichment rule is set t run every week n Sunday at 7:30 AM. 2. Chse an Actin Select the actins that yu want the Scheduler t run. Fr details, see "Actin Definitin Dialg HPE Universal CMDB (10.31) Page 193 f 300

194 Chapter 9: Scheduler Bx" n page Schedule a Task Set the schedule fr activating a task in the Scheduler pane. Fr details, see "Jb Definitin Dialg Bx" n page 198. Nte: When updating a schedule fr a task, all jbs run, by default, immediately upn saving the change. If yu d nt want jbs t run immediately upn updating the schedule, but rather when they are due t run, d the fllwing: In the Administratin mdule > Infrastructure Settings Manager > Integratin Settings, set the value fr Enable Scheduled Jbs Aut Run t false (ID: enable.scheduled.jbs.aut.run). Example f a Scheduled Task The illustratin belw shws that the Scheduler is set t run an Enrichment rule called SAP_ Old_Transprts every day at 1:00 AM and 6:00 AM. HPE Universal CMDB (10.31) Page 194 f 300

195 Chapter 9: Scheduler Hw t Rebuild Indexes n Micrsft SQL Databases UCMDB is an nline transactin prcessing (OLTP) applicatin. It perfrms many insert, update, and delete peratins each day, its indexes might becme fragmented. The index fragmentatin culd be even higher if discvery jbs that run als mdify the data. T help rebuild fragmented indexes n Micrsft SQL database, the RebuildIndexes jb is intrduced. It uses a stred prcedure t defragment the indexes. The RebuildIndexes jb is deactivated by default. Yu can start the jb manually when necessary. Hw t manually start rebuilding fragmented indexes Yu can start rebuilding fragmented indexes manually by using either f the fllwing: Start the RebuildIndexes jb frm UCMDB UI a. On UCMDB UI, g t Administratin > Scheduler > Jb Scheduler. b. Select the RebuildIndexes jb, and click Edit. c. Mdify the jb scheduler infrmatin in the Schedule sectin f the Jb Definitin dialg. It is recmmended t run the jb n a daily basis. Fr mre infrmatin abut the scheduler ptins, see "Jb Definitin Dialg Bx" in the HPE Universal CMDB Administratin Guide. d. Click OK. Invke the rebuildindexes JMX methd frm the JMX cnsle a. Launch the Web brwser and navigate t: name>:8443/jmx-cnsle, where <Server name> is the name f the machine n which Universal CMDB is installed. b. Under UCMDB, click UCMDB:service=Dal Services t pen the JMX MBean View. c. Invke the rebuildindexes JMX methd with a custmerid parameter value f 1. Nte: During the rebuilding f the indexes, the UCMDB database lg file size may increase. Make sure that the UCMDB database lg file has enugh disk space. Befre yu invke the rebuildindexes JMX methd, make sure that the discvery, enrichment, r ther jbs that mdify the data are nt running. The RebuildIndexes jb is visible nly fr Custmer 1 (default custmer) in UI, even if the Server has multiple custmers. HPE Universal CMDB (10.31) Page 195 f 300

196 Chapter 9: Scheduler The rebuildindexes JMX methd recreates the indexes fr all custmers even if the custmerid is set t 1, in case the server has multiple custmers r has the authrized state. Hw t mdify the RebuildIndexes jb definitin and scheduler infrmatin If necessary, yu can mdify the definitin f the RebuildIndexes jb. T d s, 1. On UCMDB UI, g t Administratin > Scheduler > Jb Scheduler. 2. Select the RebuildIndexes jb, and click Edit. 3. Mdify the jb definitin and scheduler infrmatin as necessary t meet yur needs. 4. Click OK. Scheduler User Interface This sectin includes (in alphabetical rder): Actin Definitin Dialg Bx 196 Filter Dialg Bx 197 Jb Definitin Dialg Bx 198 Jb Scheduler Page 202 Select Days Dialg Bx 203 Select Hurs Dialg Bx 204 Actin Definitin Dialg Bx This dialg bx enables yu t select a required actin in a list f actins that can be run by the Scheduler. T access Click the Add buttn in the Actins pane in the Jb Definitin dialg bx. Imprtant infrmatin After selecting the required actin, click Next t display a list f actins. The list f actin details depends n which actin yu chse. Fr example, if yu select Run an Enrichment Rule, a list f the existing Enrichment Rules appears. Select the required Enrichment rules. Yu can select up t 15 items. HPE Universal CMDB (10.31) Page 196 f 300

197 Chapter 9: Scheduler Relevant tasks "Hw t Define Tasks That Are Activated n a Peridic Basis" n page 193 User interface elements are described belw (unlabeled elements are shwn in angle brackets): UI Element (A-Z) <Click a clumn header> <Right-click a clumn header> Actins Descriptin Fr details, see Srt Clumn Cntent Dialg Bx in the HPE Universal CMDB Mdeling Guide. Fr details, see Srt Clumn Cntent Dialg Bx in the HPE Universal CMDB Mdeling Guide. Fr a list f actins that can be run by the Scheduler, see "Scheduler Actins" belw. Scheduler Actins This sectin cntains a list f actins that can be run by the Scheduler. Rerun Discvery n View. Runs discvery n the CIs in a selected view. This enables yu t cnfigure a general discvery fr the entire infrastructure n a less frequent basis, such as nce a week, while updating the CIs in imprtant views mre frequently, fr example, n a daily basis. Run an Enrichment Rule. Activates the selected Enrichment rule accrding t its set schedule. Click Next t display a list f the available Enrichment rules and select the required nes. Fr details, see Enrichment Manager in the HPE Universal CMDB Mdeling Guide. Filter Dialg Bx This dialg bx enables yu t filter the tasks displayed n the Jb Scheduler page. T access Click the Filter buttn n the Jb Scheduler page. Relevant tasks "Hw t Define Tasks That Are Activated n a Peridic Basis" n page 193 User interface elements are described belw (unlabeled elements are shwn in angle brackets): UI Element (A- Z) Descriptin <click a clumn header> Fr details, see Srt Clumn Cntent Dialg Bx in the HPE Universal CMDB Mdeling Guide. HPE Universal CMDB (10.31) Page 197 f 300

198 Chapter 9: Scheduler UI Element (A- Z) Descriptin <right-click a clumn header> Cnditin Display Name Fr details, see Srt Clumn Cntent Dialg Bx in the HPE Universal CMDB Mdeling Guide. Click inside the bx and select the required peratr. Fr details, see Attribute Operatr Definitins in the HPE Universal CMDB Mdeling Guide. Filters the task list accrding t ne f the fllwing: Active Jb Definitin Last Run Time Name Next Run Time Schedule Fr details, see the Jb Scheduler page. Value Click inside the bx and either enter r select the required value. Jb Definitin Dialg Bx This dialg bx enables yu t add actins t the jb yu created and define hw ften they run. T access Click the Add buttn n the Jb Scheduler page. Relevant tasks "Hw t Define Tasks That Are Activated n a Peridic Basis" n page 193 User interface elements are described belw: UI Element (A-Z) Jb Definitin Name Descriptin (Optinal) A descriptin fr this jb. The name f the jb. HPE Universal CMDB (10.31) Page 198 f 300

199 Chapter 9: Scheduler Actins Pane This area enables yu t add the required actins t the task yu created. Relevant tasks "Hw t Define Tasks That Are Activated n a Peridic Basis" n page 193 User interface elements are described belw: UI Element (A- Z) Descriptin Add. Adds an actin t the task. Opens the Actin Definitin dialg bx. Edit. Enables yu t edit an existing actin. Delete. Deletes an actin. Up. Mves a selected rw up. Dwn. Mves a selected rw dwn. Actin Definitin Name Displays the actin details yu selected in the Actin Definitin dialg bx fr the actin added. Displays the name f the actin that was added t the jb. Scheduler Pane This area enables yu t set the schedule fr activating a task. Imprtant infrmatin When updating a schedule fr a task, all jbs run, by default, immediately upn saving the change. If yu d nt want jbs t run immediately upn updating the schedule, but rather when they are due t run, d the fllwing: In the Administratin mdule > Infrastructure Settings Manager > Integratin Settings, set the value fr Enable Scheduled Jbs Aut Run t false (ID: enable.scheduled.jbs.aut.run). Relevant tasks "Hw t Define Tasks That Are Activated n a Peridic Basis" n page 193 HPE Universal CMDB (10.31) Page 199 f 300

200 Chapter 9: Scheduler See als Crn Expressins in the HPE Universal CMDB Mdeling Guide User interface elements are described belw (unlabeled elements are shwn in angle brackets): UI Element (A-Z) Descriptin Autmatically set the time zne t the crrect ne fr the server. (Appears when yu select Crn). Click t validate the Crn expressin yu entered. <Schedule ptins> Select the required ptin fr scheduling the task. The available ptins are: Once. Activates the task nly nce. Interval. Activates the actin at a set time interval. Daily. Runs a task n a daily basis. Weekly. Runs a task n a weekly basis. Mnthly. Runs a task n a mnthly basis. Crn. Use a Crn expressin t schedule a jb. Fr a descriptin f the fields used in Crn expressins and examples f hw t use them, see Crn Expressins in the HPE Universal CMDB Mdeling Guide. Crn Expressin (Appears when yu select Crn). Enter a Crn expressin in the prper frmat. Fr a descriptin f the fields used in Crn expressins and examples f hw t use them, see Crn Expressins in the HPE Universal CMDB Mdeling Guide. Days f mnth (Appears when yu select Mnthly). Click the buttn t the right f the Days f mnth bx t pen the Select Days dialg bx and chse the day f the mnth n which yu want t run the actin. Fr details, see the Select Days dialg bx. Days f the week (Sunday - Saturday) End by (Appears when yu select Weekly). Select the day r days n which yu want the actin t run. (Des nt appear when yu select Once). Chse the date and time when yu want the actin t stp running by selecting the End by check bx and then clicking the dwn-arrw t the right f the bx. HPE Universal CMDB (10.31) Page 200 f 300

201 Chapter 9: Scheduler UI Element (A-Z) Descriptin Nte: This step is ptinal. If yu d nt want t specify an ending date, leave the End by check bx unselected. Invcatin Hur (Appears when yu select Daily, Weekly, r Mnthly.) Chse the time t activate the actin. Click the buttn t the right f the Invcatin Hur bx t pen the Select Hurs dialg bx. Fr details, see the Select Hurs dialg bx. Nte: Yu can als enter the time manually in the Invcatin hur bx. Separate times by a cmma and enter AM r PM after the hur. The manually entered actin times are nt restricted t the hur and half hur nly: yu can assign any hur and minute cmbinatin. Use the fllwing frmat: HH:MM AM, fr example, 8:15 AM, 11:59 PM. Invcatin Time Mnths f the year (January - December) Repeat every (Appears when yu select Once). Chse the date and time yu want the actin t begin running by clicking the dwn-arrw t the right f the bx. (Appears when yu select Mnthly). Select the mnth r mnths in which yu want the actin t run. (Appears nly when yu select Interval). Type a value fr the interval between successive runs and then chse the required unit f time measurement (Minutes, Hurs, r Days). Nte: After each change, the next time that the jb runs is the current time plus the interval, that is, the jb des nt start immediately. Start at (Des nt appear when yu select Once). Chse the date and time when the actin must begin running by selecting the Start at check bx, pening the calendar, selecting the date and time, and clicking OK. Nte: When selecting the start time, the time zne in the start time is set accrding t the client machine s lcatin, althugh it may nt match the value selected in Time Zne. This step is ptinal. If yu d nt want t specify a beginning time, leave the Start at check bx unselected. HPE Universal CMDB (10.31) Page 201 f 300

202 Chapter 9: Scheduler UI Element (A-Z) Time Zne Descriptin Select the time zne accrding t which the Prbe must schedule jbs. The default is <<Data Flw Prbe Time Zne>>: the Prbe uses its wn system-defined time zne. This enables scheduling t take place at different times in different gegraphical lcatins. Fr all Prbes t start wrking at the same time, select a specific time zne. (This assumes that the Prbes' system date/time and time zne are crrectly cnfigured.) Jb Scheduler Page This page enables yu t define tasks that are activated n a peridic basis. Fr example, yu can define a task that generates a Tplgy reprt n a daily basis at 3:00 PM. Or, yu can define a schedule fr taking snapshts f a specific view n a daily basis. T access Relevant tasks Select Scheduler frm the Administratin mdule n the Navigatin Menu r select Managers > Administratin > Scheduler. "Hw t Define Tasks That Are Activated n a Peridic Basis" n page 193 User interface elements are described belw (unlabeled elements are shwn in angle brackets): UI Element (A-Z) Descriptin Add. Enables yu t create and schedule a jb. Opens the Jb Definitin dialg bx. Edit. Enables yu t edit a task. Opens the Jb Definitin dialg bx. Delete. Deletes the selected jb. Nte: The user cannt delete a jb scheduler linked t a pattern-based mdel. Filter. Opens the Filter dialg bx which enables yu t filter the scheduled jbs displayed n the Jb Scheduler page. Clear. Clears the filter definitins created in the Filter dialg bx. HPE Universal CMDB (10.31) Page 202 f 300

203 Chapter 9: Scheduler UI Element (A-Z) Descriptin Custmize Clumns. Enables yu t change the display rder f the clumns, hide a clumn, r display a hidden clumn. Opens the Select Clumns dialg bx. Fr details, see Select Clumns Dialg Bx in the HPE Universal CMDB Mdeling Guide. Refresh. Refreshes the display f the jbs in the Jb Scheduler page. <Click a clumn header> <Rightclick a clumn header> Active Jb Definitin Last Run Time Name Next Run Time Fr details, see Srt Clumn Cntent Dialg Bx in the HPE Universal CMDB Mdeling Guide. Fr details, see Srt Clumn Cntent Dialg Bx in the HPE Universal CMDB Mdeling Guide. Select the check bx t activate the scheduled jb. A descriptin f the scheduled jb as defined in the Jb Definitin field in the Jb Definitin dialg bx. The last time the jb was run. The name f the scheduled jb. The next time the jb is scheduled t run. Schedule Hw ften the jb is scheduled t run. Fr details, see "Scheduler Pane" n page 199. Select Days Dialg Bx This dialg bx enables yu t chse the day n which t activate the actin. T access Click Mnthly in the Jb Definitin dialg bx, and then click the buttn t the right f the Days f mnth bx. Relevant tasks "Hw t Define Tasks That Are Activated n a Peridic Basis" n page 193 HPE Universal CMDB (10.31) Page 203 f 300

204 Chapter 9: Scheduler User interface elements are described belw (unlabeled elements are shwn in angle brackets): UI Element (A-Z) Descriptin Actins Select All. Select all the days. Clear Selectin. Clear all the selected days. Invert Selectin. Switch the selectin. <List f days frm 1-31> Chse the required days by selecting the required check bxes. Yu can select multiple days. The selected days appear in the Days f mnth bx. Fr details, see "Scheduler Pane" n page 199. Select Hurs Dialg Bx This dialg bx enables yu t chse the time at which t activate the actin. T access Relevant tasks In the Jb Definitin dialg bx, click Daily, Weekly, r Mnthly, and then click the buttn t the right f the Invcatin hur bx. "Hw t Define Tasks That Are Activated n a Peridic Basis" n page 193 User interface elements are described belw (unlabeled elements are shwn in angle brackets): UI Element (A-Z) Descriptin Actins Select All. Select all the times. Clear Selectin. Clear all the selected times. Invert Selectin. Switch the selectin. <List f times by the hur and half hur> Chse all the required times by selecting the required check bx. Yu can select multiple times. The selected hurs appear in the Invcatin hur bx. Fr details, see "Scheduler Pane" n page 199. HPE Universal CMDB (10.31) Page 204 f 300

205 Chapter 10: Recipients Manager This chapter includes: Recipients Manager Overview 205 Hw t Define an Recipient 205 Cnfigurable Rate Settings 205 Recipients Manager User Interface 206 Recipients Manager Overview The Recipients Manager enables yu t define the recipients wh can autmatically receive scheduled reprts thrugh , at regular intervals, frm the Reprts mdule. Fr details, see Reprts in the HPE Universal CMDB Mdeling Guide. Hw t Define an Recipient Yu create a new recipient by clicking the Add buttn n the Recipients Manager page and entering the recipients name and address. Fr details, see "Add Mail Recipient Dialg Bx" n the next page. Cnfigurable Rate Settings The table belw describes the new infrastructure settings available fr cnfiguring sender and recipient rate (Administratin > Infrastructure Settings Manager > Mail Settings): Name Recipient rate Descriptin Recipient cannt receive mre than 1 within X secnds (X is the cnfigurable amunt f secnds, 0 means n limit). Default value is 10, this Default Value 10 HPE Universal CMDB (10.31) Page 205 f 300

206 Chapter 10: Recipients Manager Name Sender rate Sender t same recipient rate Descriptin means that a recipient is able t receive up t 6 s in a minute, n matter wh is the sender. Sender cannt send mre than 1 within X secnds (X is the cnfigurable amunt f secnds, 0 means n limit). Default value is 5, this means that a sender is able t send up t 12 s in a minute, n matter wh is the recipient. Sender cannt send mre than 1 within X secnds t the same recipient (X is the cnfigurable amunt f secnds, 0 means n limit). Default value is 20. This means that a sender is able t send up t 3 s in a minute t the same recipient. Default Value 5 20 These settings may influence n each ther, meaning that mdifying ne culd have an impact n the ther tw. That is t say, setting the cnfigurable value fr ne f these 3 settings t 0 means there is n limitatin r restrictin fr that particular case; setting all 3 settings t 0 means n spam cntrl is desired. Admin users can easily restre these settings t their default values by selecting a setting and clicking the Restre Default buttn. Recipients Manager User Interface This sectin includes (in alphabetical rder): Add Mail Recipient Dialg Bx 206 Recipients Manager Page 207 Add Mail Recipient Dialg Bx This dialg bx enables yu t create a new recipient r edit the prperties f an existing ne. T access T create a new recipient, click the Add buttn n the Recipients Manager page. T edit the prperties f an existing recipient, select the required recipient and click the buttn. HPE Universal CMDB (10.31) Page 206 f 300

207 Chapter 10: Recipients Manager Relevant tasks "Hw t Define an Recipient" n page 205 See als "Recipients Manager Overview" n page 205 User interface elements are described belw: UI Element (A- Z) Descriptin Add. Adds an address fr the recipient. Yu can add mre than ne address. Delete. Deletes the selected address. Name Enter the name f the recipient. Recipients Manager Page This page enables yu t create new recipients r edit the prperties f existing recipients. T access Imprtant infrmatin Select Recipients Manager frm the Administratin mdule n the Navigatin Menu r select Managers > Administratin > Recipients Manager. The recipients that appear n the Recipients Manager page are updated with the recipients defined in Reprts (click the Open Address Bk buttn in the Send t bx in the Schedule Reprt dialg bx t pen the Message Recipients dialg bx). Only the recipients whse addresses are defined here can autmatically receive scheduled reprts thrugh frm the Reprts mdule. Relevant tasks "Hw t Define an Recipient" n page 205 See als "Recipients Manager Overview" n page 205 User interface elements are described belw: UI Element (A-Z) Descriptin Add. Enables yu t define a new recipient. Edit. Enables yu t edit the selected recipient. HPE Universal CMDB (10.31) Page 207 f 300

208 Chapter 10: Recipients Manager UI Element (A-Z) Descriptin Delete. Deletes the selected recipient. (s) Name The addresses f the recipient. The name f the recipient. HPE Universal CMDB (10.31) Page 208 f 300

209 Chapter 11: CI Lifecycle and the Aging Mechanism This chapter includes: The Aging Mechanism Overview 209 CI Lifecycle Overview 210 Hw t Enable and Run the Aging Mechanism 210 Hw t Generate CI Lifecycle Data and Filter the Results 212 CI Lifecycle User Interface 213 Aging Parameters 219 The Aging Mechanism Overview After yur system has been running fr sme time, previusly discvered CIs may n lnger exist. Such CIs shuld be remved frm the CMDB t keep it up t date. Data Flw Management (DFM) runs peridically and, by default, updates the last access time fr all CIs and relatinships that it discvers. This prcess is knwn as "tuching", and prevents CIs and relatinships that represent active cmpnents in the system frm becming deletin candidates. If DFM des nt discver a CI that exists in the CMDB, the last access time is nt updated, s after sme predefined time (by default, 20 days) the CI becmes a deletin candidate. The aging perid is set per CI type as a static attribute in the CI Type Manager (Deletin Candidate Perid). Deletin candidates are reviewed and managed in the CI Lifecycle mdule. If the CI remains untuched fr a lnger perid f time (by default, 40 days), the aging mechanism deletes the CI frm the system. In ther wrds, aging deletes CIs and relatinships that are n lnger relevant, that is, have nt been accessed fr a specified perid f time (by default, 40 days). The deletin f large quantities f CIs and relatinships creates a significant lad fr the CMDB and database servers and can impact the verall CMDB perfrmance. T reduce this perfrmance impact, the aging mechanism divides the bjects t be deleted int chunks. A delay between chunks lwers the database lad and enables ther tasks t cntinue wrking. Fr faster wrk, yu can shrten the delay, HPE Universal CMDB (10.31) Page 209 f 300

210 Chapter 11: CI Lifecycle and the Aging Mechanism but the default delay value is the recmmended delay. Fr details, see "Aging Parameters" n page 219. Nte: Tuch parameters are defined in the DataFlwPrbe.prperties file. Fr details, see the Prbe Manager Cnfiguratins sectin in DataFlwPrbe.prperties File in the HPE Universal CMDB Data Flw Management Guide. The aging mechanism is enabled by default. Aging peratins are run nly n CIs and relatinships that have Enable Aging set t true. By default, CIs and relatinships added by ut-f-the-bx DFM adapters are created with Enable Aging set t true. (Fr details, see Enable Aging in the Cnfiguratin Item Prperties Dialg Bx in the HPE Universal CMDB Mdeling Guide.) This behavir can be changed in the Enable aging check bx in DFM in the Adapter Cnfiguratin tab (in the Results Management pane). Fr details, see Adapter Cnfiguratin Tab in the HPE Universal CMDB Data Flw Management Guide and "Enable Aging" n page 214. CI Lifecycle Overview The CI Lifecycle applicatin enables yu t view a list f CIs and relatinships that are candidates fr deletin by the aging mechanism, and t initiate the aging prcedure. Yu can als select specific CIs r relatinships and pstpne their deletin r mark them as deletin-prf. Fr each CIT, yu can set the time perid befre a specific CI becmes a candidate fr deletin r befre it is actually deleted. Fr details, see Actual Deletin Perid, Deletin Candidate Perid, and Enable Aging in the Cnfiguratin Item Prperties Dialg Bx in the HPE Universal CMDB Mdeling Guide. Hw t Enable and Run the Aging Mechanism This task describes hw t enable aging and run the aging mechanism. This task includes the fllwing steps: "Enable Aging" n the next page "First Aging Run" n the next page HPE Universal CMDB (10.31) Page 210 f 300

211 Chapter 11: CI Lifecycle and the Aging Mechanism 1. Enable Aging Access the Aging Status tab n the CI Lifecycle page (Managers > Administratin > CI Lifecycle). Select the Enable Aging check bx. Fr details, see "Aging Status Tab" n page 214. Nte: When aging is turned n r ff (that is, enabled r disabled), yu must restart the server fr the changed setting t take effect. T turn n aging fr an existing CI, access the CI in IT Universe Manager, right-click it and select Prperties. Set the Enable Aging prperty t True and click OK. T set aging t be enabled by default fr all new CIs f a specific type, access the CI type in the Attributes tab f CI Type Manager, select the Enable Aging attribute and click Edit. In the Edit Attribute dialg bx, select True fr the Default Value and click OK. 2. First Aging Run After yur system has been running fr sme time, there are prbably many CIs that need deleting. Yu shuld perfrm this step in the prcedure t keep the CMDB up t date. If the number f CIs t be deleted is greater than 10,000, a cnfirmatin message is displayed. Chse between the fllwing ptins: CI Lifecycle divides the number f CIs and/r relatinships that must be deleted int chunks (t avid verlading the database), deletes them, and adds the infrmatin t the Histry. Chunk size is determined by the value in the Aging Chunk Size field in the Infrastructure Settings Manager. This is the preferred methd f deletin because the Histry is updated with the infrmatin and there is n server dwntime. Yu run the database aging tl, lcated at C:\hp\UCMDB\UCMDBServer\tls\dbscripts\dbtl.bat. If yu chse this ptin, yu must stp the UCMDB server service. Yu wuld chse this secnd ptin if yu needed a fast system f deletin: the database aging tl is an rder f magnitude faster than the aging mechanism. Cautin: Befre running this ptin, be aware f the fllwing: Yu must cmpletely shut dwn the server befre running the tl, that is, there will be server dwntime. Befre running the database aging tl, disable the database's transactin lgging scheme (such as transactin lgs r recvery lgs), t speed up the tl's running time. HPE Universal CMDB (10.31) Page 211 f 300

212 Chapter 11: CI Lifecycle and the Aging Mechanism After running the database aging tl, run clearprbedata.bat n every Data Flw Prbe. This file resides in the fllwing lcatin: C:\hp\UCMDB\DataFlwPrbe\tls. Nte: The clearprbedata script resets the Data Flw Prbe's DB Schemas and file system state. After running this script the Data Flw Prbe re-sends all discvered data t UCMDB. This culd ptentially create a significant lad n the UCMDB Server. N infrmatin is saved in the Histry. T run the database aging tl: a. Back up the CMDB database schemas. This step is mandatry. b. Run the tl in a testing envirnment befre running it in a prductin envirnment. This step is recmmended. c. Stp the UCMDB server. d. Run the dbtl.bat file frm the file system. e. Restart the UCMDB server. f. Return t the Aging Status tab and enable aging. g. Invke clearprbedata.bat n every Data Flw Prbe cnnected t the UCMDB Server. Hw t Generate CI Lifecycle Data and Filter the Results This task describes hw t generate a list f CIs that are candidates fr deletin, and t filter the results. This task includes the fllwing steps: "Generate CI Lifecycle Data" belw "Filter the CI Lifecycle Results" n the next page 1. Generate CI Lifecycle Data T generate CI Lifecycle results fr CIs r relatinships, select either the CIs tab r the Relatinship tab. Select the time perid in which t search, using the drp-dwn calendars in the Frm and T fields, and click Generate. Fr details, see "CI Lifecycle Page" n page 218. HPE Universal CMDB (10.31) Page 212 f 300

213 Chapter 11: CI Lifecycle and the Aging Mechanism CI Lifecycle displays a list f CIs that are candidates fr deletin. Tip: If n results are generated, try extending the time perid further int the future. 2. Filter the CI Lifecycle Results T filter the CI Lifecycle data, click the Filter buttn t pen the Filter dialg bx. Fr each clumn by which yu want t filter, select a cnditin frm the drp-dwn list and fill in the value clumn, either by entering a value, selecting frm a drp-dwn list, r using the calendar. Click OK t apply yur filter. T clear the filter and restre the riginal results, click the Clear Dialg Bx" n page 218. buttn. Fr details, see "Filter CI Lifecycle User Interface This sectin includes (in alphabetical rder): Aging Run Statistics Dialg Bx 213 Aging Status Tab 214 CI Lifecycle and Relatinship Tabs 215 CI Lifecycle Page 218 Filter Dialg Bx 218 Aging Run Statistics Dialg Bx This dialg bx enables yu t view statistics fr the five previus runs f the aging mechanism. T access Click the Statistics buttn n the CI Lifecycle page. Relevant tasks "Hw t Enable and Run the Aging Mechanism" n page 210 User interface elements are described belw: UI Element (A-Z) Aging Runs Descriptin Run at. The start and finish time f the run. HPE Universal CMDB (10.31) Page 213 f 300

214 Chapter 11: CI Lifecycle and the Aging Mechanism UI Element (A-Z) Descriptin Deleted. The number f CIs that have been deleted. Failed. The number f CIs that have nt been deleted. Errrs ID. The IDs f the failed CIs, that is, f the CIs that culd nt be deleted. Errr message. A message describing the cause f failure. Aging Status Tab This dialg bx enables yu t enable the aging mechanism and t run the mechanism fr the first time. T access Select CI Lifecycle frm the Navigatin Menu r select Administratin > CI Lifecycle. Imprtant infrmatin This tab displays infrmatin abut the number f CIs that are candidates fr deletin, and functins as fllws, if yu select the Enable Aging check bx: If the number f CIs fr deletin is larger than 10,000, yu can chse t use the aging mechanism t delete the CIs in chunks, r t use the database aging tl. Fr details n which prcedure t use, see "First Aging Run" n page 211. If the number f CIs fr deletin is smaller than 10,000, the estimated time fr deletin is displayed and the CIs are immediately deleted. A prgress bar shws the stage f the deletin. Relevant tasks "Hw t Enable and Run the Aging Mechanism" n page 210 See als "The Aging Mechanism Overview" n page 209 User interface elements are described belw: UI Element (A-Z) Enable Aging Descriptin T enable aging, select the check bx. The frequency and size f the chunks that are marked as candidates fr deletin are determined in Infrastructure Settings. Fr details, see "Aging Parameters" n page 219. T disable aging, clear the check bx. HPE Universal CMDB (10.31) Page 214 f 300

215 Chapter 11: CI Lifecycle and the Aging Mechanism UI Element (A-Z) Run results Descriptin Ttal CIs t delete. The number f CIs r relatinships that are delete candidates and that are being deleted by the aging mechanism. Deleted. The number f CIs r relatinships that have been deleted. Failed. CIs r relatinships that culd nt be deleted. If any failures exist, click the Failed link t view their details. CI Lifecycle and Relatinship Tabs This area enables yu t display a list f CIs and relatinships that are candidates fr deletin, and t manage the list (fr example, t delete r prevent r pstpne deletin f specific CIs, t view statistics, and t filter the list). T access Select Administratin > CI Lifecycle. Relevant tasks "Hw t Generate CI Lifecycle Data and Filter the Results" n page 212 See als "CI Lifecycle Overview" n page 210 "The Aging Mechanism Overview" n page 209 "Wrking with CIs" in the HPE Universal CMDB Mdeling Guide User interface elements are described belw (unlabeled elements are shwn in angle brackets): UI Element (A-Z) Descriptin Pstpne Deletin. Enables yu t delay the deletin f a CI by ne aging perid. It disappears frm the list f candidates fr deletin. (If the CI is nt tuched again fr a full aging perid, it again becmes a candidate fr deletin.) Mark as Deletin Prf. Enables yu t prevent a CI r relatinship frm being deleted. It disappears frm the list f candidates fr deletin. Delete. Deletes the selected CI r relatinship. Statistics. Enables yu t view statistics (such as the start and finish time f each run and the number f deleted CIs), fr the previus five runs f the aging mechanism. Fr details, see "Aging Status Tab" n the HPE Universal CMDB (10.31) Page 215 f 300

216 Chapter 11: CI Lifecycle and the Aging Mechanism UI Element (A-Z) Descriptin previus page. Select/Clear All. Selects r clears all data n the current page. Refresh. Refreshes the displayed data. Filter. Opens the Filter dialg bx, which enables yu t custmize the filter. Fr details, see "Filter Dialg Bx" n page 218. Clear. Clears the filter and display the full results. Custmize Clumns. Opens the Select Clumns dialg bx, which enables yu t change the display rder f the clumns, hide a clumn, r display a hidden clumn. Fr details, see "Select Clumns Dialg Bx" n page 1 in the HPE Universal CMDB Mdeling Guide. Click the arrw t define the number f rws that shuld appear n each display page. Click t navigate thrugh the results page by page r t jump t the first r last page. Generates data fr a selected perid. Tip: If n results are generated, try extending the time perid further int the future (the T field). Exprt Data t File. Enables yu t select the frmat fr previewing and exprting the table data. The available ptins are: CSV. The table data is frmatted as a cmma-separated values (CSV) text file that can be displayed in a spreadsheet. Nte: Fr the CSV frmatted table data t display crrectly, the cmma (,) must be defined as the list separatr. In Windws, t verify r mdify the list separatr value, pen Reginal Optins frm the Cntrl Panel, and n the Numbers tab ensure that the cmma is defined as the List Separatr value. PDF. The table data is exprted in PDF frmat. Nte: When exprting t PDF, select a reasnable number f HPE Universal CMDB (10.31) Page 216 f 300

217 Chapter 11: CI Lifecycle and the Aging Mechanism UI Element (A-Z) Descriptin clumns t display t ensure that the reprt is legible. XLS. The table data is frmatted as an.xls (Excel) file that can be displayed in a spreadsheet. XML. The table data is frmatted as an XML file that can be pened in a text r XML editr. <Right-click a CI> <Right-click a clumn header> CIs/Relatinships tabs Fr details n the menu ptins, see in the HPE Universal CMDB Mdeling Guide. Fr details, see "Srt Clumn Cntent Dialg Bx" n page 1 in the HPE Universal CMDB Mdeling Guide. Select t see a list f CIs r relatinships that are candidates fr deletin: Select. Select the check bx t select a CI r relatinship befre perfrming an peratin n it (such as Delete r Pstpne Deletin). End1. The query nde at ne end f the relatinship (relevant nly fr relatinships). Display Label. The name f the CI r relatinship as it appears in the Tplgy Map. End2. The query nde at the secnd end f the relatinship (relevant nly fr relatinships). CI Type. The type f the CI r relatinship. Last Access Time. The last time that the CI r relatinship was accessed, whether it was updated r discvered by the DFM prcess. Updated by. The administratr r prcess that updated the CI r relatinship. Actual Delete Time. The date and time when the CI r relatinship is deleted. Frm Relatinships tab Rws per Page Click the arrw and use the calendar t select the beginning date and time fr the CI Lifecycle results. Select t see lifecycle results fr relatinships. Select the number f rws per page frm the drp-dwn list. HPE Universal CMDB (10.31) Page 217 f 300

218 Chapter 11: CI Lifecycle and the Aging Mechanism UI Element (A-Z) T Descriptin Click the arrw and use the calendar t select the end date and time fr the CI Lifecycle results. CI Lifecycle Page This page enables yu t enable and run the aging mechanism. It als enables yu t display a list f CIs and relatinships that are candidates fr deletin and t manage the list (fr example, t delete, prevent, r pstpne deletin f specific CIs, t view statistics, and t filter the list). T access Imprtant infrmatin Select Administratin > CI Lifecycle. The CI Lifecyle page includes the fllwing tabs: Aging Status. Use this tab t enable the aging mechanism and t run aging. Fr details, see "Aging Status Tab" n page 214. CIs. Use this tab t display a list f CIs that are candidates fr deletin. Fr details, see "CI Lifecycle and Relatinship Tabs" n page 215. Relatinships. Displays the same infrmatin as the CIs tab, with the additin f the End1 and End2 clumns. The tab that is displayed by default depends n whether aging is enabled r disabled: If aging is enabled, the CIs tab is displayed. If aging is disabled, the Aging Status tab is displayed. Relevant tasks "Hw t Enable and Run the Aging Mechanism" n page 210 "Hw t Generate CI Lifecycle Data and Filter the Results" n page 212 See als "CI Lifecycle Overview" n page 210 "The Aging Mechanism Overview" n page 209 Wrking with CIs in the HPE Universal CMDB Mdeling Guide Filter Dialg Bx This dialg bx enables yu t filter the list f CIs that are candidates fr deletin. T access Click Filter n the CI Lifecycle page. HPE Universal CMDB (10.31) Page 218 f 300

219 Chapter 11: CI Lifecycle and the Aging Mechanism Relevant Tasks "Hw t Generate CI Lifecycle Data and Filter the Results" n page 212 See als "CI Lifecycle Overview" n page 210 User interface elements are described belw: UI Element (A-Z) Cnditin Display Name Value Descriptin Click in the Cnditin clumn and select an ptin. The clumns displayed fr the CIs r relatinships n the CI Lifecyle page. Click in the Value clumn t set a value fr the selected cnditin. Depending n the cnditin selected, yu can select a value frm a drp-dwn list, select a date and time frm the calendar, r click the ellipsis buttn t pen an editing dialg bx where yu can enter a value. When the cnditins Like r Like ignre case are selected in the Cnditin clumn, yu can use a wildcard (%) befre and after the string fr which yu are searching. Nte: Yu must select a cnditin befre entering a value. Aging Parameters Aging parameters are defined in Infrastructure Settings (Administratin > Infrastructure Settings Manager > Aging Settings): Aging Chunk Size. The number f CIs r relatinships that are sent t the aging mechanism at ne time. The default is 5,000. Aging Scheduler Hur f the First Run. Defines at what time aging first runs after server startup (fr example, 2=2:00 AM). Aging Scheduler Interval. Defines the interval between aging runs. The interval value is in hurs. Delay Between Chunks in Millisecnds. The perid between ne chunk being deleted by the aging mechanism and the next chunk being sent t the aging mechanism t be deleted. The default is 30 secnds, that is, 30,000 millisecnds. HPE Universal CMDB (10.31) Page 219 f 300

220 Cnfiguring Security HPE Universal CMDB (10.31) Page 220 f 300

221 Chapter 12: User Permissins fr UCMDB This chapter includes: User Permissins in a Single Tenant Envirnment 221 User Permissins Wrkflw 222 User Permissins fr the UCMDB Brwser 223 Multi-Tenancy Overview 226 User Permissins in a Multi-Tenancy Envirnment 229 Tenant Assciatin Rules 233 Cnfiguratin Manager in a Multi-Tenant UCMDB Envirnment 235 Multi-Tenancy Wrkflw 236 Hw t Change the Tenant Assignment fr a Resurce r a CI 237 User Permissins User Interface 238 User Permissins in a Single Tenant Envirnment Nte: When wrking in a multi-tenancy envirnment, refer t "User Permissins in a Multi- Tenancy Envirnment" n page 229. All resurces (queries, views, impact rules, and custm reprts) are assigned a resurce wner. The resurce wner is defined as the user wh created the resurce and cannt be changed t a different resurce wner. Hwever it is pssible t delete the wnership f the resurce, which results in a resurce with n resurce wner. Users are assigned rles which define the permissins they have. A user's permissin t perfrm a specific actin n a specific resurce is determined by the fllwing factrs: The user wh is the resurce wner f a resurce has all permissins fr that resurce. Fr a user wh is nt the resurce wner, the user must be assigned a rle that includes the requested permissin fr that resurce. HPE Universal CMDB (10.31) Page 221 f 300

222 Chapter 12: User Permissins fr UCMDB Flders are als cnsidered resurces and fllw the same permissins rules as ther resurces. The permissins applied t a flder autmatically apply t all the resurces cntained in the selected flder. In rder t delete r update a flder, yu need delete r update permissin n its parent flder. An additinal type f permissin that is relevant fr flders is Create permissin, which enables yu t create resurces in that flder. Create permissin can be selected fr queries, views, Impact rules, and custm reprts. Create permissin fr a flder als enables yu t create sub-flders in that flder. There are als general actins that are nt linked t specific resurces, such as the general actin Data Update, which permits the user t update CIs in any view fr which he has Update permissin. It is ften necessary fr a user t have a set f different permissins t enable him t perfrm a specific peratin. Thus, fr a user t make changes t the CIs in a specific view in IT Universe Manager, he requires the fllwing permissins: Permissin t access the IT Universe Manager mdule. Update permissin fr the specific view. Permissin fr the general actin Data Update. If he is lacking this permissin, he cannt update the CIs in the view. Fr details n the available resurce permissins and general actins, see "Permissins Summary" n page 268. User Permissins Wrkflw Nte: When wrking in a multi-tenancy envirnment, refer t "Multi-Tenancy Wrkflw" n page 236. The fllwing task describes a typical wrkflw in a single-tenant envirnment: 1. Create Resurce Grups If relevant, create resurce grups in the Resurce Grups mdule t assist in defining permissins during rle creatin. Fr details, see "Hw t Define a Resurce Grup" n page Create Rles Create rles in the Rles Management mdule defining the permissins yu want t assign t different users. Fr details, see "Hw t Create a New Rle and Define Permissins fr the Rle" n page 260. HPE Universal CMDB (10.31) Page 222 f 300

223 Chapter 12: User Permissins fr UCMDB 3. Create Users and Grups and Assign Rles t Them Create users and user grups in the Users and Grups mdule. Assign rles t the users and grups accrding t the permissins yu want t grant each ne. Fr details, see "Users and Grups Wrkflw" n page Review the Rle Assignments Review the rles assigned t each user and grup t ensure that the users have been granted the required permissins. Check the Permissins Overview tab in the Users and Grups mdule. Fr details, see "Users and Grups Page" n page 254. User Permissins fr the UCMDB Brwser T view and update data in the UCMDB Brwser, permissins fr specific views and CIs are required. These permissins are assigned in the Brwser CI Access Cntrl tab and they are nt relevant t the permissins fr the UCMDB user interface. Permissin fr the general actin View CIs is required in additin t the CI permissins defined in this tab (permissin fr the Data Update general actin is nt relevant). TQL query calculatin is ptimized when a user's wrld cntains fewer than 1000 CIs and links (nt including federated data). Nte: The size f a user s wrld is calculated nce in each 24-hur perid t see if TQL query calculatin can be ptimized. Any change in an IT wrld that reduces a user s wrld size t less than the threshld will cause the ptimizatin t ccur nly after that nce-per-day calculatin is perfrmed. Defining Permissin fr All CIs Yu can grant permissin t view r edit all CIs in the CMDB by selecting ne f the check bxes at the tp f the page: View All. Grants permissin t view all CIs and relatinships in the CMDB. Edit All. Grants permissin t view all CIs and relatinships and t edit all CIs in the CMDB. HPE Universal CMDB (10.31) Page 223 f 300

224 Chapter 12: User Permissins fr UCMDB Defining Permissin fr CIs by Views View permissin fr the views themselves is based n the view permissins granted fr the UCMDB UI in the Resurces tab. Any view included in the rle's permitted views can als be viewed in the UCMDB Brwser. (Yu can als grant view permissin fr a view using the View ptin described belw.) Hwever, additinal permissins are required t edit the CIs f the view. When Views is selected as the resurce type (Views mde), yu can select a specific view r flder and assign any f the fllwing permissins: View. Grants permissin t view all CIs and relatinships returned by the view. (This is equivalent t the view permissin granted in the Resurces tab.) Edit All CIs. Grants permissin t view all CIs and relatinships and t edit all CIs returned by the view. Edit By CIT. Grants permissin t view all CIs and relatinships returned by the view and t edit the CIs returned by the view that match the CI types selected in CI Types mde. When yu apply this ptin, a dialg bx gives yu the ptin t switch t CI Types mde and select Edit In View. In additin, the user wh created a view (the wner f the view) has view permissin fr the CIs in that view, even if the view is nt included in any f the user's rles. Defining Permissin fr CIs by CI Types When CI Types is selected as the resurce type (CI Types mde), yu can select a CI type in the tree and select any f the fllwing actins: View All CIs. Grants permissin t view all CIs f the selected type anywhere in the CMDB. Edit All CIs. Grants permissin t view and edit all CIs f the selected type anywhere in the CMDB. Edit In View. Grants permissin t edit CIs f the selected type in views fr which Edit By CIT permissin was granted in Views mde. When yu apply this ptin, a dialg bx gives yu the ptin t switch t Views mde and select Edit By CIT. Create CI. Grants permissin t create CIs f the selected type. Nte: Permissins fr relatinships cannt be assigned by relatinship type. A rle that has edit r create permissins fr tw CIs is als granted permissin t create relatinships between them accrding t the templates defined in the Assisted Mdeling feature f the Brwser. HPE Universal CMDB (10.31) Page 224 f 300

225 Chapter 12: User Permissins fr UCMDB CI Permissins Example T demnstrate the CI permissins, cnsider a view which cntains a Nde CI, an IP Address CI, and an IP Subnet CI. The fllwing are pssible permissin cnfiguratins fr this view: Edit All CIs permissin fr the view in Views mde. This grants view and edit permissin fr all three CIs in the view, even if n permissins were assigned in CI Types mde. Edit All CIs permissin fr the Nde, IP Address, and IP Subnet CI types in CI Types mde. This grants view and edit permissin fr all three CIs in the view, even if n permissins were assigned in Views mde. Edit By CIT permissin fr the view in Views mde and Edit In View permissin fr Nde and IP Address CI types. This grants view and edit permissin fr the Nde and IP Address CIs, but nt fr the IP Subnet CI. Defining Permissins by Calculated Relatinship Triplets In the CI Type Manager, yu define triplets in the Triplets tab fr calculated relatinships. Each triplet cnsists f a surce CI type, a target CI type, and a relatinship. Such triplets can be used t add permissins t rles as fllws: Fr calculated relatinships f type authrized_relatinship_add, if a rle includes permissin fr bth the surce and target CI types, the triplet definitin als grants it permissin t create the specified relatinship between CIs f thse types. Fr calculated relatinships f type Flding rules, if a rle includes permissins fr the surce CI type, then the same permissins are granted fr the target CI type as well as permissin t view the specified relatinship between CIs f thse types. (This fllws the CI cmpsitin lgic used in HPE Universal CMDB Cnfiguratin Manager. Fr details, see "Cntent Management Overview" in the HPE Universal CMDB Cnfiguratin Manager User Guide.) Fr example, if a Flding rule defines a triplet f nde CI type related t an IP address CI type via cntainment, users that have permissins t view r edit a nde CI have the same permissins fr the IP address CI related t the nde via cntainment and permissin t view the cntainment relatinship between a nde CI and an IP address CI. Nte: A user wh creates a CI r relatinship in the Assisted Mdeling feature f the UCMDB Brwser (the wner f the bject) has all permissins fr that bject. HPE Universal CMDB (10.31) Page 225 f 300

226 Chapter 12: User Permissins fr UCMDB Multi-Tenancy Overview Nte: This sectin is nly relevant when multi-tenancy is enabled. This sectin includes the fllwing tpics: "Intrductin" belw "Owner and Cnsumer Tenants" belw "Resurce Owner" n the next page "Default Tenants fr Users and Grups" n the next page "User Ownership and Tenancy Rules" n the next page "Default Tenant Rules - Advanced Infrmatin" n page 228 Intrductin Multi-tenancy is the ability fr multiple custmers r tenants t use the same shared UCMDB envirnment. UCMDB enables multiple tenants t use an implementatin f the UCMDB with layered permissins. This enables tenant users t access nly that data and thse resurces that are relevant t that tenant. This includes CI data and resurces such as TQLs, views, reprts, snapshts, and s frth. Multi-tenancy is a methd f wrking in UCMDB which allcates the CIs in yur IT Universe and the resurces in yur system t varius tenants. There are tw main layers t multi-tenancy, tenants and users. Permissins are applied acrss UCMDB based n the tenant assigned and the user's permissin levels. Bth the tenant level and the user's permissin level determines what can be created and accessed in the system. Owner and Cnsumer Tenants Each CI, view, query, custm reprt, r Impact rule can belng t ne particular tenant, knwn as the wner tenant f the resurce. Other tenants can be designated as cnsumer tenants f the same resurce. Owner tenant status is assciated with full permissin fr the resurce (view, update, and delete). Cnsumer tenant status is assciated with partial permissin (view nly). The wner tenant f a resurce is als autmatically included as a cnsumer tenant f that resurce. The wner tenant and cnsumer tenants can be updated in the Assign Tenants dialg bx. When yu assign an wner tenant r cnsumer tenant t a flder, all f the resurces in that flder are assigned HPE Universal CMDB (10.31) Page 226 f 300

227 Chapter 12: User Permissins fr UCMDB that tenant as an inherited wner tenant r an inherited cnsumer tenant respectively. (Inherited tenants are nt relevant fr CIs.) There can thus be ne wner tenant assigned t a resurce, but it can have several inherited wner tenants frm its cntaining flders. A resurce can have several cnsumer tenants and it is pssible t select all existing tenants as cnsumer tenants fr a resurce. Fr details n assigning tenants t resurces, see "Assign Tenants Dialg Bx" n page 238. Resurce Owner Every resurce, ther than CIs, is als assigned a resurce wner, which is independent f the resurce's wner tenant. The resurce wner is defined as the user wh created the resurce and cannt be changed t a different resurce wner. Hwever it is pssible t delete the wnership f the resurce, which results in a resurce with n resurce wner (the tenancy f the resurce is unaffected). The resurce wner is an additinal prperty nt related t the tenant prperty that enables the user that created a resurce t 'wn' that resurce. Fr example, if a user belnging t a specific tenant has permissins t create TQLs but may nt have general view and updates permissins, the user as the resurce wner has permissins t view and update nly the TQL he created. Default Tenants fr Users and Grups Every UCMDB user and user grup can be assigned a default tenant. The default tenant f the user r the user's grup can be used t define the wner tenant and cnsumer tenants f CIs and resurces created by that user. Yu can set the default tenant fr a user r grup by clicking the Set Default Tenant buttn in the tlbar f the Users and Grups mdule, r select the tenant in the wizard during creatin f the user r grup. Fr rules and additinal infrmatin n the default tenant, see "Multi-Tenancy Overview" n the previus page. User Ownership and Tenancy Rules The fllwing table summarizes the user wnership and tenancy rules fr CIs and ther resurces: Term Descriptin As Applied t Resurces As Applied t CIs Resurce wner The user that created the resurce. Resurce can have nly ne N/A HPE Universal CMDB (10.31) Page 227 f 300

228 Chapter 12: User Permissins fr UCMDB Term Descriptin As Applied t Resurces As Applied t CIs Autmatically defined as the user lgged in at the time f creatin Cannt be changed (but can be deleted) Owner tenant The tenant that has full permissin n the resurce r CI. Can have ne assigned wner tenant and multiple inherited wner tenants Autmatically defined based n the user lgged in at the time f creatin Can be updated, but there must be an wner tenant defined Only ne Autmatically defined based n the user lgged in at the time f creatin Can be updated, but there must be an wner tenant defined Cnsumer tenant The tenant r tenants that can cnsume r use the resurce r CI. Can be multiple Autmatically defined based n the user lgged in at the time f creatin Can be updated r Can be multiple Autmatically defined based n the user lgged in at the time f creatin deleted Can be updated r deleted Default Tenant Rules - Advanced Infrmatin The initial wner tenant and cnsumer tenants f a new CI r resurce are determined accrding t the fllwing rules: When a user creates a resurce, the initial wner tenant and cnsumer tenant f that resurce are defined as the user's default tenant. Nte: The same tenant is used fr bth the initial wner tenant and cnsumer tenant f the created resurce. HPE Universal CMDB (10.31) Page 228 f 300

229 Chapter 12: User Permissins fr UCMDB If the user has n default tenant defined and the user is a member f ne r mre grups, UCMDB checks the default tenant f each grup (including a recursive check f the parent grups). If a single default tenant is shared in cmmn by the grups, that tenant is used fr the resurce. Nte: If sme f the user's grups share a cmmn default tenant, and the ther grups have n default tenant defined, the cmmn tenant is used fr the resurce. If any grup has a different default tenant, neither tenant is used fr the resurce. If neither f the abve criteria were satisfied, UCMDB checks all f the user's rle assignments. If all f the rle assignments fr the user are in cnnectin with the same tenant, that tenant is defined as the initial wner tenant and cnsumer tenant f the created CI r resurce. If nne f the abve cnditins are satisfied, the initial wner tenant and cnsumer tenant are cnfigured in the CMDB settings. User Permissins in a Multi-Tenancy Envirnment Nte: This sectin is nly relevant when multi-tenancy is enabled. When wrking in a singletenant envirnment, refer t "User Permissins in a Single Tenant Envirnment" n page 221. This sectin includes the fllwing tpics: "Required Permissins fr Resurces" belw "User Permissins fr General Actins" n page 232 "Required Permissins fr Tenant Assignments" n page 233 "Multi-Tenancy in Package Manager" n page 233 Required Permissins fr Resurces Users are assigned rles which define the permissins they have. The rle assignments are defined in cnnectin with specific tenants. A user's permissin t perfrm a specific actin n a specific resurce is determined by several factrs: The user wh is the resurce wner f a resurce has all permissins fr that resurce (except fr permissin t change the tenant assignment). HPE Universal CMDB (10.31) Page 229 f 300

230 Chapter 12: User Permissins fr UCMDB Fr a user wh is nt the resurce wner, the fllwing cnditins must be satisfied fr permissin t perfrm a requested actin: The user is assigned a rle that includes the requested permissin fr that resurce. The tenant assciated with that rle assignment matches the relevant tenant f the resurce. Fr view permissin, it must match ne f the cnsumer tenants (r inherited cnsumer tenants) f the resurce. Fr update r delete permissin, it must match the wner tenant (r ne f the inherited wner tenants) f the resurce. Fr example, cnsider a rle that grants update permissin fr the query server_query and view permissin fr the query database_query. Yu assign this rle t the user UCMDB_user in cnnectin with the tenant ABC Crpratin. (UCMDB_user is nt the resurce wner f either query.) ABC Crpratin is amng the cnsumer tenants f bth server_query and database_query, but it is nt the wner tenant r inherited wner tenant f either query. UCMDB_user can thus view database_query, because the rle grants him view permissin in cnnectin with a cnsumer tenant f that query. Hwever, he cannt update server_query despite the update permissin granted by the rle, because the rle was nt assigned in cnnectin with the wner tenant f that query. HPE Universal CMDB (10.31) Page 230 f 300

231 Chapter 12: User Permissins fr UCMDB Flders are als cnsidered resurces and fllw the same permissins rules as ther resurces. The permissins applied t a flder autmatically apply t all the resurces cntained in the selected flder. In rder t delete r update a flder, yu need delete r update permissin n its parent flder. An additinal type f permissin that is relevant fr flders is Create permissin, which enables yu t create resurces in that flder. Create permissin can be selected fr queries, views, Impact rules, and custm reprts. Create permissin fr a flder als enables yu t create sub-flders in that flder. Fr a user t create resurces in a flder, the rle assigned t him must be assciated with the tenant that is the wner tenant (r inherited wner tenant) f the selected flder. Thus if the wner tenant f a flder is ABC Crpratin and a user is assigned a rle with Create Views permissin fr that flder in cnnectin with the tenant XYZ Bank, he is unable t create any views in that flder. Nte: Fr UI Mdule and CIT Menu Item permissins, the tenant assignment is nt relevant. HPE Universal CMDB (10.31) Page 231 f 300

232 Chapter 12: User Permissins fr UCMDB User Permissins fr General Actins A similar requirement is applied fr determining a user's permissins fr mst general actins. If a user is granted permissin fr the general actin View CIs in cnnectin with a specific tenant, he can nly view CIs that include that tenant amng its cnsumer tenants r wner tenant. If a user is granted permissin fr the general actin Update Data in cnnectin with a specific tenant, he can nly update CIs whse wner tenant matches that tenant. Fr example, suppse a user is assigned a rle which grants him permissin fr the general actins View CIs and Update Data in cnnectin with tenant_a. The fllwing are the tenancy assignments fr three CIs in a view: DB_1. Owner tenant: tenant_a, Cnsumer tenants: tenant_a, tenant_b DB_2. Owner tenant: tenant_c, Cnsumer tenants: tenant_a, tenant_c CPU_1. Owner tenant: tenant_b, Cnsumer tenants: tenant_b, tenant_c The user thus has update and view permissin fr DB_1, but view permissin nly fr DB_2. He has n permissins fr CPU_1 (the CI is nt visible t him). If the same rle was assigned t him in cnnectin with bth tenant_a and tenant_b, he wuld have update and view permissin fr bth DB_1 and CPU_1, but view permissin nly fr DB_2. It is ften necessary fr a user t have a set f different permissins t enable him t perfrm a specific peratin. Thus, fr a user t view the CIs in a specific view in IT Universe Manager, he requires the fllwing permissins: Permissin t access the IT Universe Manager mdule. The tenant assignment is nt relevant fr this permissin. View permissin fr the specific view (r fr all views) in cnnectin with a tenant that is amng the cnsumer tenants f that view. If he is lacking this permissin, he will nt see the view at all. Permissin fr the general actin View CIs in cnnectin with a tenant that is amng the cnsumer tenants f each CI in the view. If he is lacking this permissin, he will see an empty view. If he has this permissin in cnnectin with a tenant that is included amng the cnsumer tenants f nly sme f the view's CIs, he will see nly thse CIs. Nte: Fr sme general actins, such as Access t SDK, the tenant assignment is nt relevant. HPE Universal CMDB (10.31) Page 232 f 300

233 Chapter 12: User Permissins fr UCMDB Required Permissins fr Tenant Assignments T view the tenant assignments fr a resurce r CI, permissin fr the general actin View Tenant Assignment is required, in cnnectin with the wner tenant r inherited wner tenant f the resurce. If a user is assigned a rle with this permissin, he can view the wner tenant and cnsumer tenants f the resurce, but he will nly see the resurce's cnsumer tenants that are assciated with the rle assignment. Fr example, a user has permissin fr the general actin View Tenant Assignment in cnnectin with tenants T1 and T2. The fllwing are the tenancy assignments fr tw resurces: Query_1 has wner tenant T1 and cnsumer tenants T1, T2, and T3. Query_2 has wner tenant T3 and cnsumer tenants T1, T2, and T3. The user can view the tenant assignments fr Query_1, hwever he nly sees T1 and T2 as the cnsumer tenants (he has n permissin in cnnectin with T3). He cannt view the tenant assignments fr Query_2 because his View Tenant Assignment permissin is nt assciated with the wner tenant f that resurce. T mdify the tenant assignment fr a resurce r CI, permissin fr the general actin Reassign Tenant is required, in cnnectin with the wner tenant r inherited wner tenant f the resurce and with the tenants being mdified. Multi-Tenancy in Package Manager In a multi-tenancy envirnment, tenants are cnsidered resurces that can be included in a package and then deplyed and exprted. In additin, when a resurce, such as a query, view, r impact rule, is added t a package, the tenant assignment fr that resurce is als included in the package. Fr details n Package Manager, see "Package Manager" n page 156. Tenant Assciatin Rules Nte: This sectin is nly relevant when multi-tenancy is enabled. When wrking in a multi-tenancy envirnment, it is ften necessary t apply the same tenancy definitins t many CIs. A cnvenient way t d this is by using Tenant Assciatin rules, which are a frm f Enrichment rules. Yu define Tenant Assciatin rules in the Enrichment Manager in the same way that yu define Enrichment rules. HPE Universal CMDB (10.31) Page 233 f 300

234 Chapter 12: User Permissins fr UCMDB The Tenant Assciatin rule yu define fr a query nde determines the tenant t be assciated with that query nde. When the rule is run, all CIs in yur IT Universe that match the tplgy f the Tenant Assciatin rule are assigned the specified wner tenant r cnsumer tenants, accrding t the rule definitin. The frequency with which a Tenant Assciatin rule runs is determined by the pririty assigned t the rule. The fllwing Tenant Assciatin rules are prvided ut-f-the-bx: SetOwnerTenantOfCmpsedCI. Overwrites the wner tenant f the Cmpsed CI with the wner tenant f the Cntainer CI. AppendCnsumerTenantsTCmpsedCI. Appends the cnsumer tenants f the Cntainer CI t the cnsumer tenants f the Cmpsed CI. SetCnsumerTenantsOfCmpsedCI. Overwrites the cnsumer tenants f the Cmpsed CI with the cnsumer tenants f the Cntainer CI. AppendOwnerTenantTImpactedCI. Appends the wner tenant f the Impacted By CI t the cnsumer tenants f the Impacted CI. AppendCnsumerTenantsTImpactedCI. Appends the cnsumer tenants f the Impacted By CI t the cnsumer tenants f the Impacted CI. These Tenant Assciatin rules are templates which yu can use t build a custmized rule fr yur IT envirnment. Fr example, cnsider the SetOwnerTenantOfCmpsedCI rule, which has tw query ndes, a Cntainer CI and a Cmpsed CI, with a cmpsitin relatinship frm the Cntainer CI t the Cmpsed CI. Yu can refine the type f the Cntainer CI t IP Subnet, and refine the type f the Cmpsed CI t Cmputer. The pattern f the rule is then an IP Subnet cnnected t a Cmputer by a cmpsitin relatinship. When the rule runs, all Cmputer CIs that match this pattern have their wner tenant verwritten with the wner tenant f the related IP Subnet. Nte: The ut-f-the-bx Tenant Assciatin rules are inactive by default. T activate a rule, select the Rule is Active check bx in the Tenant Assciatin Rule Prperties wizard. It is nt recmmended t activate the ut-f-the-bx rules in their riginal cnfiguratin, due t the large size f the query results. First, mdify a rule t limit its results and then activate it. Fr details n defining Tenant Assciatin rules, see "Define a Tenant Assciatin Rule" in the HPE Universal CMDB Mdeling Guide. HPE Universal CMDB (10.31) Page 234 f 300

235 Chapter 12: User Permissins fr UCMDB Cnfiguratin Manager in a Multi-Tenant UCMDB Envirnment While Cnfiguratin Manager itself des nt supprt multi-tenancy, it can cnnect t a multi-tenant UCMDB envirnment. T ensure that end users view UCMDB resurces and CIs in a tenant-safe fashin, Cnfiguratin Manager shuld be set up in ne f the fllwing ways: Cnfiguratin Manager fr UCMDB Administratin Only (Recmmended) In a multi-tenant UCMDB envirnment, Cnfiguratin Manager can functin as the UCMDB administratin tl. In this case, nly administratrs - wh have permissin t see all tenant-related infrmatin - can define cnfiguratin plicies and/r track changes, while end-users with permissins assciated with a specific tenant can view the resurces t which that tenant is assigned, thrugh the UCMDB Brwser. This is achieved as fllws: Plicies are defined in Cnfiguratin Manager, and can be cnsumed by end-users in a tenant-safe way thrugh the UCMDB Brwser. A view defined in UCMDB t display data fr all tenants can be managed in Cnfiguratin Manager and plicies can be applied n tp f the view. While administratrs accessing the Cnfiguratin Manager UI can view the plicy status fr all CIs in this view, end-users accessing the UCMDB Brwser can cnsume nly the plicy status f thse CIs that they are authrized t see. In Cnfiguratin Manager, plicies can be applied t tenant-specific CIs by specifying the tenant in the Owner Tenant attribute in the plicy's filter. This ensures that the plicy is applied nly t CIs whse wner tenant is the specified tenant. Nte: Yu need t add the Managed qualifier t the Owner Tenant attribute in the CI Type Manager t make this attribute visible in the Cnfiguratin Manager attribute filter. Cnfiguratin Manager fr End-User Functinality In a multi-tenant UCMDB envirnment, when all end users have direct access t the Cnfiguratin Manager UI, views managed in Cnfiguratin Manager must cntain tenant-specific data, and access t these views must be cnfigured t be limited t the tenants assciated with the users' permissins fr these views. HPE Universal CMDB (10.31) Page 235 f 300

236 Chapter 12: User Permissins fr UCMDB While this ptin enables all end-users t access Cnfiguratin Manager, it requires cnfiguratin and maintenance f each individual view, per the relevant tenant. Multi-Tenancy Wrkflw Nte: This sectin is nly relevant when multi-tenancy is enabled. The fllwing task describes a typical wrkflw in a multi-tenancy envirnment: 1. Add Tenants Begin by adding tenants t the tenant repsitry in the Tenants Management mdule. Fr details, see "Tenants Management Page" n page Create Resurce Grups If relevant, create resurce grups in the Resurce Grups mdule t assist in defining permissins during rle creatin. Fr details, see "Hw t Define a Resurce Grup" n page Create Rles Create rles in the Rles Management mdule defining the permissins yu want t assign t different users. Fr details, see "Hw t Create a New Rle and Define Permissins fr the Rle" n page Create Users and Grups and Assign Rles t Them Create users and user grups in the Users and Grups mdule. If relevant, assign default tenants t the users and grups. Fr details, see "Multi-Tenancy Overview" n page 226. Assign rles t the users and grups accrding t the permissins yu want t grant each ne. Fr details, see "Users and Grups Wrkflw" n page 245. When assigning a rle t a user, select the tenants assciated with that assignment, as described in "Rle Assciatin Page" n page Review the Rle and Tenant Assignments Review the rles assigned t each user and grup and the tenants assciated with each rle assignment t ensure that the users have been granted the required permissins. Check the HPE Universal CMDB (10.31) Page 236 f 300

237 Chapter 12: User Permissins fr UCMDB Permissins Overview tab in the Users and Grups mdule. Fr details, see "Users and Grups Page" n page Change the Tenant Assignment fr a Resurce r a CI When a resurce r CI is created, the wner tenant and cnsumer tenant are autmatically assigned based n the tenant f the user wh created the resurce r CI. Fr details, see "Multi- Tenancy Overview" n page 226. Yu can change the autmatic assignments fr a resurce r CI. Fr details, see "Hw t Change the Tenant Assignment fr a Resurce r a CI" belw. 7. Define a Tenant Assciatin Rule - Optinal Fr advanced users wrking with large amunts f data, yu can define rules that determine hw tenants are assciated with resurces and CIs. Fr details, see Hw t Define a Tenant Assciatin Rule in the HPE Universal CMDB Mdeling Guide. Hw t Change the Tenant Assignment fr a Resurce r a CI Nte: This sectin is nly relevant when multi-tenancy is enabled. The fllwing task describes hw t change the wner tenant and cnsumer tenants fr a resurce r a CI: 1. Lcate the Required Resurce r CI Fr views and queries, g t Mdeling Studi and select the required resurce in the Resurces tab f the left pane. Fr impact rules, g t Impact Analysis Manager and select the required impact rule. Fr custm reprts, g t the Reprts mdule and select the required custm reprt. Right-click the resurce and select Assign Tenants. Fr CIs, g t IT Universe Manager and select the required CI. Right-click the CI and select Assign Tenants. 2. Update the Owner Tenant In the Assign Tenants dialg bx, select a tenant frm the drp-dwn list in the Owner Tenant HPE Universal CMDB (10.31) Page 237 f 300

238 Chapter 12: User Permissins fr UCMDB field. The selected tenant becmes the wner tenant f the resurce r CI. Fr details, see "Assign Tenants Dialg Bx" belw. 3. Update the Cnsumer Tenants In the Cnsumer Tenants sectin f the dialg bx, select the cnsumer tenants. The selected tenants becme the cnsumer tenants f the resurce r CI. Fr details, see "Assign Tenants Dialg Bx" belw. 4. Save the Changes Click Save t save yur changes t the tenant assignment. User Permissins User Interface This sectin includes (in alphabetical rder): Assign Tenants Dialg Bx 238 Assign Resurces t Rles and Resurce Grups Dialg Bx 241 Assign Tenants Dialg Bx This dialg bx enables yu t update the wner tenant and cnsumer tenants f a resurce r a CI. Nte: This sectin is nly relevant when multi-tenancy is enabled. T access In Mdeling Studi, click the Assign Tenants buttn n the tlbar f the TQL Query Editr r right-click a resurce in the Resurces tab and select Assign Tenants frm the shrtcut menu. In the Reprts mdule, click the Assign Tenants buttn n the Custm Reprts tlbar r right-click a custm reprt and select Assign Tenants frm the shrtcut menu. In Impact Analysis Manager, click the Assign Tenants buttn n the tlbar r right-click an Impact rule and select Assign Tenants frm the shrtcut menu. HPE Universal CMDB (10.31) Page 238 f 300

239 Chapter 12: User Permissins fr UCMDB In IT Universe Manager, right-click a CI and select Assign Tenants frm the shrtcut menu. Imprtant infrmatin The Cnsumer Tenants sectin has different functinality depending n the number f resurces selected: When a single resurce is selected, mve the required tenants frm the Available Tenants pane t the Selected Tenants pane using the arrw buttns. Alternatively, select All tenants t select all the available tenants. When multiple resurces are selected, select the check bxes in the Assigned clumn t assign the required tenants t all the selected resurces. Alternatively, select All tenants t assign all the available tenants t all the selected resurces. Nte: When updating the wner tenant r cnsumer tenants using the Assign Tenants dialg bx, be aware that there may be a Tenant Assciatin rule defined which verrides yur manual tenant assignment. In that case the tenant assignments defined in the rule will take effect the next time that the rule runs. Relevant tasks "Hw t Change the Tenant Assignment fr a Resurce r a CI" n page 237 "Multi-Tenancy Wrkflw" n page 236 See als "Multi-Tenancy Overview" n page 226 User interface elements are described belw: UI Element (A-Z) <Arrw buttns> Descriptin The fllwing arrw buttns are available: Add. Mves the selected tenants in the Available Tenants pane t the Selected Tenants pane. Remve.Remves the specified tenants frm the Selected Tenants pane. Add All. Mves all the tenants in the Available Tenants pane t the Selected Tenants pane. Remve All. Remves all the tenants frm the Selected Tenants pane. Nte: These buttns are nly available when a single resurce is selected. All tenants Select All tenants t assign all tenants t the resurce. HPE Universal CMDB (10.31) Page 239 f 300

240 Chapter 12: User Permissins fr UCMDB UI Element (A-Z) Descriptin Nte: When yu select All tenants, the Cnsumer Tenants sectin becmes disabled. Assigned The check bxes indicate the assignment status f each tenant as fllws: A selected check bx (a blue arrw) indicates that the tenant is assigned t each selected resurce as a cnsumer tenant. A blank check bx indicates that the tenant is nt assigned t any selected resurce. A triangle in the check bx indicates a mixed status: the tenant is assigned t at least ne selected resurce, but nt t all f them. Select a check bx t assign that tenant t all f the selected resurces as a cnsumer tenant. Clear a check bx t remve the tenant assignment frm all the selected resurces. If yu leave the mixed status indicatr in a check bx, the previus cnsumer tenant assignments fr that tenant remain unchanged. If ne f the selected resurces has All tenants selected, and thers d nt, the All tenants check bx has a mixed indicatr and the Cnsumer Tenants sectin is disabled. Yu can clear the check bx t enable the Cnsumer Tenants sectin, mdify the cnsumer tenant assignments, and then re-select the All tenants check bx. The resurce with All tenants remains unchanged, but the cnsumer tenant assignments f the ther resurces are updated. If a tenant is an inherited cnsumer tenant fr at least ne f the selected resurces, the check bx is disabled. Nte: This item is nly available when multiple resurces are selected. Available Tenants Descriptin Displays the available tenants. Nte: This item is nly available when a single resurce is selected. Displays the descriptins f the available tenants. Nte: This item is nly available when multiple resurces are selected. Inherited Owner Tenants Click the arrw buttn t expand the pane displaying the inherited wner tenants fr the selected resurce(s). These are wner tenants f the parent flders f the resurce(s). The inherited wner tenants are displayed in tree frmat (with the HPE Universal CMDB (10.31) Page 240 f 300

241 Chapter 12: User Permissins fr UCMDB UI Element (A-Z) Descriptin relevant resurces appearing under each tenant, in the case f multiple resurces). Nte: This feature nly appears in the Assign Tenants dialg bx fr resurces, nt fr CIs. Name Displays the names f the available tenants. Nte: This item is nly available when multiple resurces are selected. Owner Tenant Select the wner tenant f the resurce frm the drp-dwn list. When multiple resurces with different wner tenants are selected, Multiple Tenants Assigned is the displayed ptin. If yu leave this ptin selected, the previus wner tenant assignments f the resurces remain unchanged. Selected Tenants Displays the selected tenants. Inherited cnsumer tenants appear in gray and cannt be selected. Nte: This item is nly available when a single resurce is selected. Assign Resurces t Rles and Resurce Grups Dialg Bx This dialg bx enables yu t assign specific resurces t rles and resurce grups frm within the resurce managers. T access In Mdeling Studi, click the Manage Security buttn n the tlbar f the TQL Query Editr r right-click a resurce in the Resurces tab and select Manage Security frm the shrtcut menu. In the Reprts mdule, click the Manage Security buttn n the Custm Reprts tlbar r right-click a custm reprt and select Manage Security frm the shrtcut menu. In Impact Analysis Manager, click the Manage Security buttn n the tlbar r right-click an Impact rule and select Manage Security frm the shrtcut menu. Imprtant infrmatin Yu can als assign resurces t rles and resurce grups in the Security mdules. Fr details, see "Rles Manager" n page 259 and "Resurce Grups" n page 275. HPE Universal CMDB (10.31) Page 241 f 300

242 Chapter 12: User Permissins fr UCMDB Nte: Yu need permissin fr the Administratin general actin t assign resurces t rles and resurce grups. See als "User Permissins in a Single Tenant Envirnment" n page 221 "User Permissins in a Multi-Tenancy Envirnment" n page 229 "Permissins Summary" n page 268 Rles Pane User interface elements are described belw: UI Element (A- Z) Descriptin <Permissins> Assigned Select the check bxes fr the required permissins in the apprpriate rws t assign specific permissins fr the resurce t the required rles. A green check mark indicates that at least ne permissin fr the resurce has been assigned t that rle. If yu access the dialg bx while selecting multiple resurces, a square in a permissin check bx indicates that the relevant permissin has been assigned fr at least ne f the selected resurces, but nt fr all f them. Descriptin Name Displays descriptins f the available rles. Displays the names f the available rles. Nte: Read-nly rles d nt appear in the list, since they cannt be mdified. Resurce Grups Pane User interface elements are described belw: UI Element (A-Z) Assigned Descriptin Select the check bx in the apprpriate rws t assign the resurce t the required resurce grups. HPE Universal CMDB (10.31) Page 242 f 300

243 Chapter 12: User Permissins fr UCMDB UI Element (A-Z) Descriptin If yu access the dialg bx while selecting multiple resurces, a square in a check bx indicates that at least ne f the selected resurces has been assigned t the resurce grup, but nt all f them. Descriptin Name Displays descriptins f the available resurce grups. Displays the names f the available resurce grups. Nte: The All Resurces grup des nt appear in the list (it already includes all f the resurces). HPE Universal CMDB (10.31) Page 243 f 300

244 Chapter 13: Users and Grups This chapter includes: Users and Grups Overview 244 Users and Grups Wrkflw 245 Default Passwrd Plicy 246 Users and Grups User Interface 246 Users and Grups Overview The Users and Grups mdule enables yu t create users and user grups and t assign rles t them. The rles assigned t a user r grup, alng with the tenants assciated with each assignment (in a multi-tenancy envirnment), determine the permissins granted t the user r the members f the grup. A user can be assciated with mre than ne grup. The rles assigned t a grup are autmatically assigned t each user in the grup. A user's rles include the rles assigned t the individual user, knwn as assigned rles, and the rles assigned t the user's grups, knwn as inherited rles. It is als pssible t assciate a grup with a parent grup. In such a case, the child grup inherits the rles f the parent grup and the users in the child grup inherit the rles f bth grups. Resurces, actins, and mdules fr which a user is nt granted permissin are nt visible t that user r are disabled in the user's envirnment. Nte: The Users and Grups mdule is available nly t thse lgged in with administratin access rights. Out-f-the-Bx Users The fllwing users are defined ut-f-the-bx by UCMDB: Admin. The UCMDB administratr. Sysadmin. The system administratr (used t lgin t the JMX cnsle). HPE Universal CMDB (10.31) Page 244 f 300

245 Chapter 13: Users and Grups UISysadmin. The user used fr running tasks n the server. Nte: Out-f-the-bx users appear in bld in the Users pane. Yu can update their user details but yu cannt mdify their rle assignments r delete the users. Out-f-the-bx users are nt autmatically synchrnized with the UCMDB data mdel. Merge Users Yu can merge tw users int a single user. In the Merge Users dialg bx, select ne f the users t be the master. The merged user takes the name f the master and includes the rle assignments f bth users. In a multi-tenancy envirnment, the merged user gets the default tenant f the user selected as master. If each f the riginal users were assigned the same rle in cnnectin with different tenants, the merged user is assigned the rle in cnnectin with the tenants f bth users. Nte: Out-f-the-bx users cannt be merged. The Merge Users functinality is nly relevant when exactly tw users are selected. Users and Grups Wrkflw The fllwing steps describe a typical wrkflw fr defining users and grups in yur system: 1. Define a New Grup Select the Grups tab and create a new grup using the New Grup wizard. Assign a rle r multiple rles t the grup n the Rles Assciatin page. Fr details, see "New Grup Wizard" n page Define a New User Select the Users tab and create a new user using the New User wizard. If relevant, assciate the user with at least ne grup n the Grup Assciatin page. Fr details, see "Grup Assciatin Page" n page 252. HPE Universal CMDB (10.31) Page 245 f 300

246 Chapter 13: Users and Grups 3. Assign Rles t the User Assign rles t the user n the Rles Assciatin page. Fr details, see "Rle Assciatin Page" n page Review the User's Rles In the User tab, select the user yu created. In the Rles tab f the right pane, cnfirm that the rles yu assigned t the user appear in the Assigned Rles sectin and the rles assigned t the user's grups appear in the Inherited Rles sectin. 5. Edit a User's Details If a change ccurs in a user's details, yu can edit his details, including his passwrd, time zne preference, and lcale (user interface language). Select the user in the left pane and edit his details in the Details tab. Yu can edit the details fr the user currently lgged in using the User Prfile dialg bx. Select Tls > User Prfile... t access the dialg bx. Default Passwrd Plicy The default passwrd plicy requires the passwrd t include at least ne f each f the fur fllwing types f characters: Uppercase alphabetic characters Lwercase alphabetic characters Numeric characters Symbl characters,\:/. _?&%=+-[]() It als requires the passwrd t adhere t the minimum length, which is set by the Passwrd minimum length infrastructure setting. Users and Grups User Interface This sectin includes (in alphabetical rder): New Grup Wizard 247 HPE Universal CMDB (10.31) Page 246 f 300

247 Chapter 13: Users and Grups New User Wizard 249 Select Tenants fr Rle Dialg Bx 253 Users and Grups Page 254 New Grup Wizard This wizard enables yu t create a user grup. T access Relevant tasks Wizard map Select Users and Grups frm the Security mdule n the Navigatin Menu r select Managers > Security > Users and Grups > Grups tab. Click the New Grup buttn. "Users and Grups Wrkflw" n page 245 The "New Grup Wizard" cntains: "Grup Details Page" > "Grup Assciatin Page" > "Rles Assciatin Page" > "Default Tenant Page" See als "Users and Grups Overview" n page 244 "User Permissins Wrkflw" n page 222 "Multi-Tenancy Wrkflw" n page 236 Grup Details Page This wizard page enables yu t add the details f the grup. Wizard map The "New Grup Wizard" cntains: "Grup Details Page" > "Grup Assciatin Page" > "Rles Assciatin Page" > "Default Tenant Page" User interface elements are described belw: UI Element (A-Z) Descriptin Descriptin Enter a descriptin f the user grup. Nte: This field is ptinal. HPE Universal CMDB (10.31) Page 247 f 300

248 Chapter 13: Users and Grups UI Element (A-Z) Grup Name Descriptin Enter a name fr the new user grup. Grup Assciatin Page This wizard page enables yu t assciate a user grup with ne r mre parent grups. Imprtant infrmatin Wizard map Use the arrw buttns t mve the required grups frm the Available Grups pane t the Selected Grups pane. The "New Grup Wizard" cntains: "Grup Details Page" > "Grup Assciatin Page" > "Rles Assciatin Page" > "Default Tenant Page" User interface elements are described belw: UI Element (A-Z) Available grups Selected grups Descriptin Displays the available grups. Displays the grups selected fr assciatin with the new grup. Rles Assciatin Page This wizard page enables yu t assciate a user grup with ne r mre rles. Imprtant infrmatin Wizard map Use the arrw buttns t mve the required rles frm the Available Rles pane t the Selected Rles pane. If multi-tenancy is enabled, the Select Tenants fr Rle dialg bx appears, which enables yu t assciate tenants with the rle assignment. The "New Grup Wizard" cntains: "Grup Details Page" > "Grup Assciatin Page" > "Rles Assciatin Page" > "Default Tenant Page" User interface elements are described belw: UI Element (A-Z) Available Rles Rle's Assigned Descriptin Displays the available rles. Displays the tenants assciated with the rle selected in the Selected HPE Universal CMDB (10.31) Page 248 f 300

249 Chapter 13: Users and Grups UI Element (A-Z) Tenants Descriptin Rles pane. Nte: This area is nly available when multi-tenancy is enabled. Selected Rles Displays the rles selected fr assignment t the new grup. Default Tenant Page This wizard page enables yu t assign a default tenant t the grup. Imprtant infrmatin Wizard map This wizard page is nly available when multi-tenancy is enabled. The "New Grup Wizard" cntains: "Grup Details Page" > "Grup Assciatin Page" > "Rles Assciatin Page" > "Default Tenant Page" User interface elements are described belw: UI Element (A-Z) Select tenant Descriptin Select a tenant frm the drp-dwn list t be the default tenant f the new grup. New User Wizard This wizard enables yu t create a user. T access Relevant tasks Wizard map Select Users and Grups frm the Security mdule n the Navigatin Menu r select Managers > Security > Users and Grups > Users tab. Click the New User buttn. "Users and Grups Wrkflw" n page 245 The "New User Wizard" cntains: "User Name and Passwrd Page" > "User Details Page" > "Grup Assciatin Page" > "Rle Assciatin Page" > "Default Tenant Page" See als "Users and Grups Overview" n page 244 HPE Universal CMDB (10.31) Page 249 f 300

250 Chapter 13: Users and Grups "User Permissins Wrkflw" n page 222 "Multi-Tenancy Wrkflw" n page 236 User Name and Passwrd Page This wizard page enables yu t assign a name and passwrd fr the user. Imprtant infrmatin When creating a new user, yu can either enable the passwrd plicy, in which UCMDB autmatically assigns the default passwrd t the user, r assign a passwrd f yur wn. T enable the passwrd plicy, g t Managers > Administratin > Infrastructure Settings Manager, select Passwrds must use default plicy and set the value t True. When the passwrd plicy is enabled, new users created are given the passwrd defined in the Default user passwrd setting. Nte: The UCMDB administratr must specify the passwrd fr the new users in the Default user passwrd setting. The new users must change the passwrd n first lgin (yu can als change the passwrd in the wizard). The default passwrd plicy requires the passwrd t include at least ne f each f the fur fllwing types f characters: Uppercase alphabetic characters Lwercase alphabetic characters Numeric characters Symbl characters,\:/. _?&%=+-[]() It als requires the passwrd t adhere t the minimum length, which is set by the Passwrd minimum length infrastructure setting. Wizard map The "New User Wizard" n the previus page cntains: "User Name and Passwrd Page" > "User Details Page" n the next page > "Grup Assciatin Page" n page 252 > "Rle Assciatin Page" n page 252 > "Default Tenant Page" n page 253 HPE Universal CMDB (10.31) Page 250 f 300

251 Chapter 13: Users and Grups User interface elements are described belw: UI Element (A-Z) Cnfirm Passwrd Descriptin If the Passwrds must use default plicy setting in Managers > Administratin > Infrastructure Settings Manager is set t True, UCMDB autmatically cnfirms the passwrd defined in Default user passwrd. If the Passwrds must use default plicy setting is set t False, cnfirm the passwrd yu entered in the Passwrd bx. Passwrd If the Passwrds must use default plicy setting in Managers > Administratin > Infrastructure Settings Manager is set t True (default), UCMDB autmatically assigns the passwrd defined in Default user passwrd. If the Passwrds must use default plicy setting is set t False, assign a passwrd f yur wn. User Name Enter a unique user name. User Details Page This wizard page enables yu t add the details f the user. Wizard map The "New User Wizard" cntains: "User Name and Passwrd Page" > "User Details Page" > "Grup Assciatin Page" > "Rle Assciatin Page" > "Default Tenant Page" User interface elements are described belw: UI Element (A-Z) <User details> Descriptin Enter the user's infrmatin. Use the Lcale field t select the language f the user interface fr the user.if n lcale is selected, the lcale f the web brwser is used t define the language. If n lcale is selected fr the brwser, the Operating System lcale is used. If the lcale specified in the brwser r Operating System is nt supprted by UCMDB, the default language f the user interface is English. HPE Universal CMDB (10.31) Page 251 f 300

252 Chapter 13: Users and Grups Grup Assciatin Page This wizard page enables yu t assciate a user with ne r mre grups. Imprtant infrmatin Wizard map Use the arrw buttns t mve the required grups frm the Available Grups pane t the Selected Grups pane. The "New User Wizard" cntains: "User Name and Passwrd Page" > "User Details Page" > "Grup Assciatin Page" > "Rle Assciatin Page" > "Default Tenant Page" User interface elements are described belw: UI Element (A-Z) Available grups Selected grups Descriptin Displays the available grups. Displays the grups selected fr assciatin with the new user. Rle Assciatin Page This wizard page enables yu t assciate a user with ne r mre rles. Imprtant infrmatin Wizard map Use the arrw buttns t mve the required rles frm the Available Rles pane t the Selected Rles pane. If multi-tenancy is enabled, the Select Tenants fr Rle dialg bx appears, which enables yu t assciate tenants with the rle assignment. The "New User Wizard" cntains: "User Name and Passwrd Page" > "User Details Page" > "Grup Assciatin Page" > "Rle Assciatin Page" > "Default Tenant Page" User interface elements are described belw: UI Element (A-Z) Available Rles Rle's Assigned Tenants Descriptin Displays the available rles. Displays the tenants assciated with the rle selected in the Selected Rles pane. Nte: This area is nly available when multi-tenancy is enabled. HPE Universal CMDB (10.31) Page 252 f 300

253 Chapter 13: Users and Grups UI Element (A-Z) Selected Rles Descriptin Displays the rles selected fr assignment t the new user. Default Tenant Page This wizard page enables yu t assign a default tenant t the user. Imprtant infrmatin Wizard map This wizard page is nly available when multi-tenancy is enabled. The "New User Wizard" cntains: "User Name and Passwrd Page" > "User Details Page" > "Grup Assciatin Page" > "Rle Assciatin Page" > "Default Tenant Page" User interface elements are described belw: UI Element (A-Z) Select tenant Descriptin Select a tenant frm the drp-dwn list t be the default tenant f the new user. Select Tenants fr Rle Dialg Bx This tab enables yu t select tenants t assciate with the rle assigned t a user r grup. T access Click the Edit link in the Assigned Rles sectin f the Rles tab. Select a rle r rles in the Available Rles pane and mve it t the Selected Rles pane using the arrw buttns. The dialg bx pens. Alternatively, when yu run the New User wizard r the New Grup wizard, the dialg bx pens when yu mve rles t the Selected Rles pane. Imprtant infrmatin This dialg bx is nly available when multi-tenancy is enabled. User interface elements are described belw: UI Element (A-Z) All Tenants Descriptin Select All Tenants t assciate all tenants with the rle assigned t the user r grup. HPE Universal CMDB (10.31) Page 253 f 300

254 Chapter 13: Users and Grups UI Element (A-Z) Available Tenants Selected Tenants Specified Tenants Descriptin The list f all available tenants. The tenants selected fr the rle assignment t the user r grup. Select Specified Tenants t assciate nly the specified tenants with the rle assigned t the user r grup. Users and Grups Page This tab enables yu t define new users and grups r edit existing nes. T access Relevant tasks Select Users and Grups frm the Security mdule n the Navigatin Menu r select Managers > Security > Users and Grups. "Users and Grups Wrkflw" n page 245 See als "Users and Grups Overview" n page 244 "User Permissins Wrkflw" n page 222 "Multi-Tenancy Wrkflw" n page 236 Left Pane User interface elements are described belw (unlabeled elements are shwn in angle brackets): UI Element (A-Z) Descriptin New User/New Grup. When the Users tab is selected, enables yu t create a user. When the Grups tab is selected, enables yu t create a user grup. Nte: When LDAP is enabled, the users created with the New User buttn are integratin users. Edit User/Edit Grup. Enables yu t edit the name f the selected user r HPE Universal CMDB (10.31) Page 254 f 300

255 Chapter 13: Users and Grups UI Element (A-Z) Descriptin grup. Delete. Deletes the selected user r grup. Reset Passwrd. Opens the Reset Passwrd dialg bx. This dialg bx is nly available fr administratrs. It enables yu t change the user s passwrd withut entering the ld passwrd. Nte: This buttn is nly relevant when the Users tab is selected. Set Default Tenant. Enables yu t change the default tenant f the user r grup. Nte: This buttn is nly available when multi-tenancy is enabled. Create Persn CI frm selected user. Creates a CI f type Persn fr the selected user. This enables the synchrnizatin f UCMDB users t the UCMDB data mdel. Nte: Ensure that the key attributes fr a Persn CI are supplied; therwise, duplicate CIs may be created. Fr mre infrmatin, see "CI Type Manager" in the HPE Universal CMDB Mdeling Guide. Create Persn CIs frm all users. Creates CIs f type Persn fr all users. This enables the synchrnizatin f UCMDB users t the UCMDB data mdel. Nte: Ensure that the key attributes fr a Persn CI are supplied; therwise, duplicate CIs may be created. Fr mre infrmatin, see "CI Type Manager" in the HPE Universal CMDB Mdeling Guide. Refresh. Refreshes the list f users r grups. Save. Saves the changes yu have made. <List f users> <Search feature> Cntains the list f default and custm users. LDAP users are indicated by a green check mark in the External User clumn. T search fr a phrase in the list f users r grups, enter the phrase in the Find bx. Use the arrw buttns t find the next and previus ccurrences f HPE Universal CMDB (10.31) Page 255 f 300

256 Chapter 13: Users and Grups UI Element (A-Z) Descriptin the phrase. Click the Highlight buttn t highlight all ccurrences f the phrase. Grups tab Users tab Displays the existing grups. Displays the existing users. The fllwing ptins are available by right-clicking a user r grup: UI Element (A-Z) Delete Edit User/Edit Grup Merge Users Descriptin Delete the selected user r grup. Edit the name f the selected user r grup. Merge the selected users int ne user. In the Merge Users dialg bx, select ne f them t be the master. The merged user takes the name f the master and includes the rle assignments f bth users. Nte: This ptin is nly available when tw users are selected. New User/New Grup Refresh Reset Passwrd Create a new user r grup. Refresh the list f users r grups. Opens the Reset Passwrd dialg bx. This dialg bx is nly available fr administratrs. It enables yu t change the user s passwrd withut entering the ld passwrd. Nte: This ptin is nly available fr users. Save Set Default Tenant Save the changes yu have made. Enables yu t change the default tenant f the user r grup. Nte: This ptin is nly available when multi-tenancy is enabled. HPE Universal CMDB (10.31) Page 256 f 300

257 Chapter 13: Users and Grups Right Pane User interface elements are described belw: UI Element (A-Z) Details tab Descriptin When the Grups tab is selected, displays details fr the selected grup. When the Users tab is selected, displays details fr the selected user. The Change Passwrd buttn enables yu t change the user passwrd. Enter the user s ld passwrd and the new ne in the Change User Passwrd dialg bx. Use the Lcale field t select the language f the user interface fr the user. If n lcale is selected, the lcale f the web brwser is used t define the language. If n lcale is selected fr the brwser, the Operating System lcale is used. If the lcale specified in the brwser r Operating System is nt supprted by UCMDB, the default language f the user interface is English. Under Time Zne Preferences, yu can change the time zne fr the selected user. Nte: When yu update the time zne fr the user currently lgged in, the change takes effect after 5 minutes. When yu update the time zne using the User Prfile dialg bx (accessed by Tls > User Prfile...), the change takes effect immediately. Under Server Administratr Privileges, yu can select the Enabled check bx t grant the user permissin t access the JMX cnsle. Permissins Overview Rles tab Displays a summary f the selected user r grup s permissins. Select a resurce type in the Resurce Types pane. The resurces f the selected type are displayed in the Permissins Summary pane. If yu select a resurce in the tree, the rles frm which the permissins derive are displayed in the Permissin Origin pane. The fllwing areas are displayed: Assigned Rles. Displays the rles assigned directly t the selected user r grup. Click the Edit link t edit the assigned rles. Fr details n assigning rles, see "Rle Assciatin Page" n page 252. Inherited Rles. Displays the rles assigned t a parent grup f the selected user r grup. HPE Universal CMDB (10.31) Page 257 f 300

258 Chapter 13: Users and Grups UI Element (A-Z) Descriptin Parent Grups. Displays the parent grups f the selected user r grup. Click the Edit link t edit the parent grups. Fr details n assciating grups, see "Grup Assciatin Page" n page 252. Grup Members. Displays the members f the selected grup (nly relevant fr the Grups tab). Click the Edit link t edit the members. Use the arrw buttns t mve users r grups frm the Available Users/Grups pane t the Selected Users/Grups pane. HPE Universal CMDB (10.31) Page 258 f 300

259 Chapter 14: Rles Manager This chapter includes: Rles Manager Overview 259 Hw t Create a New Rle and Define Permissins fr the Rle 260 Rles Manager User Interface 262 Permissins Summary 268 Rles Manager Overview Rles enable yu t assign permissins t users accrding t their respnsibilities in the rganizatin. Yu define rles in the Rles Manager mdule and assign rles t users in the Users and Grups mdule. Yu can assign multiple rles t a user, which grants him the cmbined permissins f all the assigned rles. There are several ways t define the permissins f a rle: Yu can select specific actins fr specific resurces, such as view, update, and delete permissin fr ne TQL query and view nly permissin fr anther ne. Yu can select specific actins fr the resurces in a previusly defined resurce grup, such as view and update permissin fr all TQL queries in the resurce grup and view and delete permissin fr all the custm reprts in the resurce grup. Resurce grups are defined in the Resurce Grups mdule. Yu can select general actins such as Create Views. It is pssible t define permissins using cmbinatins f the abve ptins. Fr details n defining the permissins f a rle, see "Rles Manager Page" n page 262. Nte: The Rles Manager mdule is available nly t thse lgged in with administratin access rights. HPE Universal CMDB (10.31) Page 259 f 300

260 Chapter 14: Rles Manager Merge Rles Yu can merge tw rles int a single rle. In the Merge Rles dialg bx, select ne f the rles t be the master. The merged rle takes the name f the master and includes the permissins f bth rles. Users that were assigned either f the riginal rles are nw assigned the merged rle. In a multi-tenancy envirnment, the tenants assciated with the rle assignment f the merged rle t a user are the same as the tenants assciated with the riginal rle t that user. If a user was assigned bth f the riginal rles in cnnectin with different tenants, he is assigned the merged rle in cnnectin with the tenants f bth rle assignments. Nte: Out-f-the-bx rles cannt be merged. The Merge Rles functinality is nly relevant when exactly tw rles are selected. Hw t Create a New Rle and Define Permissins fr the Rle The fllwing task describes hw t create a rle and define permissins fr it: 1. Create a Rle Click the New Rle buttn in the Rles pane t pen the New Rle dialg bx. Enter the name and descriptin fr the rle and click OK. Fr details, see "New Rle Dialg Bx" n page Define Permissins fr the Rle Using the Resurces Tab Yur new rle is selected by default in the Rles pane. Select the Resurces tab in the right pane and fllw these steps: a. Select a resurce type in the Resurce Types pane (fr example, Views). b. Select a resurce (fr example, a specific view frm the view tree in the Available View pane) and click the right arrw buttn. The Set Permissins dialg bx pens. (Fr UI Mdules and CIT Menu Items, the Set Permissins dialg is nt relevant.) c. In the Set Permissins dialg bx, select the required permissins fr the resurce yu selected. Yu can chse Select All t assign all the available permissins. Click Apply. HPE Universal CMDB (10.31) Page 260 f 300

261 Chapter 14: Rles Manager d. Yur selected resurce appears in the right pane with the check bxes fr the assigned permissins selected. e. Repeat this prcedure fr ther resurces f this type and fr ther resurce types, as required. Fr details, see "Resurces Tab" n page Define Permissins fr the Rle Using the Resurce Grups Tab Select the Resurce Grups tab in the right pane and fllw these steps: a. Select a resurce grup in the Resurce Grups pane. b. Select actins frm the tree in the Available Actins pane (fr example, Update permissin under Views) and click the right arrw buttn. Nte: Yu can make multiple selectins by hlding the CTRL key. c. The actins yu selected appear in the Selected Actins pane. Each selectin defines permissin fr that actin fr every resurce f that type in the resurce grup (fr example, Update permissin fr every view in the resurce grup). Fr details, see "Resurce Grups Tab" n page Define Permissins fr the Rle Using the General Actins Tab Select the General Actins tab in the right pane and fllw these steps: a. Select actins in the Available Actins pane. Nte: Yu can make multiple selectins by hlding the CTRL key. b. Click the right arrw buttn t mve them t the Selected Actins pane. c. The general actins selected are permitted fr the rle (they are nt linked t a specific resurce r resurce type). Fr details, see "General Actins Tab" n page Save the Rle Click the Save buttn in the Rles pane t save yur changes. HPE Universal CMDB (10.31) Page 261 f 300

262 Chapter 14: Rles Manager Rles Manager User Interface This sectin includes (in alphabetical rder): New Rle Dialg Bx 262 Rles Manager Page 262 New Rle Dialg Bx This dialg bx enables administratrs t create rles. T access Click the New Rle buttn in the Rles tab. Relevant tasks "Hw t Create a New Rle and Define Permissins fr the Rle" n page 260 See als "Rles Manager Overview" n page 259 "Permissins Summary" n page 268 User interface elements are described belw: UI Element (A-Z) Descriptin Rle Name Descriptin Enter a descriptin f the rle yu are defining. Enter a unique name fr the rle. Rles Manager Page This page enables yu t create and delete rles and t edit their permissins. T access Imprtant infrmatin Select Rles Manager frm the Security mdule n the Navigatin Menu r select Managers > Security > Rles Manager. Fr each rle, yu can assign permissins fr actins n resurces using the fllwing tabs: Resurces. Select specific actins fr specific resurces. Brwser CI Access Cntrl. Select permissins t view and edit CIs r CI types in the UCMDB Brwser. HPE Universal CMDB (10.31) Page 262 f 300

263 Chapter 14: Rles Manager Resurce Grups. Select specific actins fr the resurces in specific resurce grups. General Actins. Select specific general actins (such as Run Discvery and Integratins r Create Views). Yu can select actins fr permissins frm each tab. The rle is assigned permissins based n the cmbined results f selectins in all f the tabs. The Rle Details tab displays the name and descriptin f the selected rle. The Permissins Overview tab displays the selected rle s permissins. Relevant tasks "Hw t Create a New Rle and Define Permissins fr the Rle" n page 260 See als "Rles Manager Overview" n page 259 "Permissins Summary" n page 268 Rles Pane User interface elements are described belw (unlabeled elements are shwn in angle brackets): UI Element (A-Z) Descriptin New Rle. Creates a rle. Opens the New Rle dialg bx. Edit Rle. Enables yu t edit the name f the selected rle. Delete. Remves the selected rle(s). Nte: Yu can make multiple selectins t delete multiple rles. Refresh. Refreshes the list f rles. Save. Saves the changes yu have made. Save As. Saves the rle with a different name. <List f rles> <Search feature> Displays the names f the existing rles. T search fr a phrase in the list f rles, enter the phrase in the Find bx. HPE Universal CMDB (10.31) Page 263 f 300

264 Chapter 14: Rles Manager UI Element (A-Z) Descriptin Use the arrw buttns t find the next and previus ccurrences f the phrase. Click the Highlight buttn t highlight all ccurrences f the phrase. The fllwing ptins are available by right-clicking a rle: UI Element (A-Z) Delete Edit Rle Merge Rles Descriptin Remves the selected rle(s). Edit the name f the selected rle. Merge the selected rles int ne rle. In the Merge Rles dialg bx, select ne f them t be the master. The merged rle takes the name f the master. Users that were assigned either f the riginal rles are nw assigned the merged rle. Nte: This ptin is nly available when tw rles are selected. New Rle Refresh Save Save As Create a new rle. Refresh the list f rles. Save the changes yu have made. Save the rle with a different name. Right Pane The Right Pane cntains the Resurces tab, the Resurce Grups tab, the General Actins tab, and the Rle Details tab. Resurces Tab Imprtant infrmatin Select a Resurce type and use the arrw buttns t mve resurces frm the Available <resurces> pane t the Selected <resurces> pane t assign permissins fr thse resurces t the current rle. When mving resurces, yu must select the permissins fr the selected resurces, using the Set Permissins dialg bx. User interface elements are described belw: HPE Universal CMDB (10.31) Page 264 f 300

265 Chapter 14: Rles Manager UI Element (A-Z) Available <Resurce> Resurce Types Selected <Resurce> with Permissins Descriptin Displays the available resurces fr the selected resurce type in tree frmat. Select a resurce type frm the list. Displays the selected resurces and their respective permissins fr the current resurce type. The available permissins differ fr different resurce types, as fllws: Queries have view, update, delete, and snapsht permissins. Views have view, update, delete, snapsht, and archive permissins. Impact Analysis and Custm Reprts have view, update, and delete permissins. UI Mdules have access permissin. Fr CIT Menu Items, yu select a CIT frm the tree and then select specific actins frm the Available Actins pane and mve them t the Selected Actins pane. Yu can als right-click a CIT and select the actins frm the pp-up dialg bx. If n permissins are assigned fr any CIT, all the menu items are permitted by default (in accrdance with the permissins granted in the General Actins tab). Nte: The abve principle remains valid when there are multiple rles with menu items permissins/general actins. Bth the menu items permissins and the general actins are accumulated. If there are NO menu items permissins accumulated frm all the user s rles, all the menu items are permitted by default (in accrdance with the permissins granted by accumulating all the General Actins frm all the user s rles). In the ppsite way, if there are menu items permissins accumulated frm all the user s rles, they will be taken int accunt and the UI will enfrce them, even in the case when a rle with n CIT Menu Items is aggregated with a rle with CIT Menu Items. UCMDB Brwser Widgets have view permissin. Restricted Data have view and edit permissins n CITs that have the Sensitive Data attribute set in the CI Type Manager. HPE Universal CMDB (10.31) Page 265 f 300

266 Chapter 14: Rles Manager Brwser CI Access Cntrl Tab Imprtant infrmatin The Brwser CI Access Cntrl tab enables yu t define view and edit permissins fr the UCMDB Brwser. These permissins are nt relevant in the UCMDB user interface. Select Views as the resurce type t access Views mde and assign permissins accrding t the selected views and flders. Select CI Types as the resurce type t access CI Types mde and assign permissins accrding t the selected CI types. Alternatively, select ne r bth f the check bxes t assign permissins fr all CIs. Fr details n the pssible permissin cmbinatins, see "User Permissins fr the UCMDB Brwser" n page 223. User interface elements are described belw: UI Element (A-Z) <CI Types mde> Descriptin When CI Types is selected as the resurce type, select a CI type in the Resurces pane. Fr each CI type selected, use the arrw buttns t mve actins frm the Available Actins pane t the Selected Actins pane. When yu assign direct permissin fr a CI type, a green check mark appears next t the CI type in the tree in the Resurces pane. Children f the selected CI types are assigned permissin by inheritance, and they are indicated by a small red T. If ne r mre children f a CI type are assigned permissin but the subtree is cllapsed, the CI type is indicated by a small red T with a green brder. <Views mde> Edit All Resurce Types Pane When Views is selected as the resurce type, select a view in the Available Views pane. Fr each view selected, use the arrw buttns t mve the view t the Selected Views with Permissins pane. When mving views, yu must select the permissins fr the selected views, using the Set Permissins dialg bx. Grants permissin t view all CIs and relatinships and t edit all CIs in the CMDB. Select Views r CI Types. HPE Universal CMDB (10.31) Page 266 f 300

267 Chapter 14: Rles Manager UI Element (A-Z) View All Descriptin Grants permissin t view all CIs and relatinships in the CMDB. Resurce Grups Tab Imprtant infrmatin Select a resurce grup and use the arrw buttns t mve actins frm the Available Actins pane t the Selected Actins pane t assign permissins fr thse actins fr the resurces in the selected resurce grup t the current rle. User interface elements are described belw: UI Element (A-Z) Available Actins Resurce Grups Selected Actins Descriptin Displays the available actins per resurce. Displays the available resurce grups. Resurce grups used by the selected rle are marked with a green asterisk. Displays the permitted actins selected fr the resurces in the selected resurce grup fr the current rle. Nte: The selected actins are permitted fr the resurces relevant t that actin. If yu select the Create actin under Queries, the rle receives permissin t create flders and queries in all f the query flders in the resurce grup. General Actins Tab Imprtant infrmatin Use the arrw buttns t mve actins frm the Available Actins pane t the Selected Actins pane t assign them t the current rle. User interface elements are described belw: UI Element (A-Z) Available Actins Descriptin Displays the available general actins. HPE Universal CMDB (10.31) Page 267 f 300

268 Chapter 14: Rles Manager UI Element (A-Z) Selected Actins Descriptin Displays the general actins selected fr permissins fr the current rle. Rle Details Tab User interface elements are described belw: UI Element (A-Z) Descriptin Descriptin Enter a descriptin f the rle. Nte: This field is ptinal. Name Displays the rle name. Permissins Overview Tab Imprtant infrmatin Displays a summary f the selected rle s permissins. Select a resurce type in the Resurce Types pane. The resurces f the selected type are displayed in the Permissins Summary pane. If yu select a resurce in the tree, the rles frm which the permissins derive are displayed in the Permissin Origin pane. Permissins Summary The fllwing sectin describes the hierarchy f required permissins fr wrking in UCMDB. It begins with the mst fundamental permissin and cntinues thrugh the different levels f permissin needed fr varius actins. At each level f permissin, the permissins f all the previus levels are als required. The mst basic permissin required is the general actin Access t UI permissin. Withut this permissin, the user cannt lg in. This permissin is added by default when a new rle is created. The next level f permissin needed t use UCMDB functinality is the permissin fr the individual UI mdules, lcated in the Resurce Types pane f the Resurces tab. If a user lacks permissin fr a specific mdule, that mdule is nt visible t him. Nte: Fr sme mdules, yu can assign permissin fr specific subsectins f the mdule. HPE Universal CMDB (10.31) Page 268 f 300

269 Chapter 14: Rles Manager Fr example, under Mdeling Studi, yu can select Views, Queries, and Mdels each individually fr permissin in the rle. The next level f permissin depends n the specific functinality required. These are assigned by the general actins described in the table belw and by the permissins granted fr individual resurces in the Resurces tab. When multi-tenancy is enabled, ne specific general actin, View CIs permissin, is necessary fr a brad categry f functinality, including ther general actins such as View Histry and Allw Search. Withut this permissin, the user cannt see the CIs in a view even if he has permissin fr that view. This permissin is als added by default when a new rle is created. Nte: Fr queries, views, impact rules, and custm reprts, View permissin is the base permissin. Fr all ther permissins (update, delete, snapsht, and archive), yu must als assign view permissin fr the selected resurce. If a rle includes view permissin fr a view r an impact rule, it als autmatically includes view permissin fr the base query f the view r impact rule. If the rle includes update permissin fr a view r impact rule, it des nt autmatically include update permissin fr the base query. View permissin fr a view includes permissin t view a saved snapsht f the view r an archived reprt f the view. When multi-tenancy is enabled, the CIs visible in the snapsht r archived reprt are the nes whse tenant assignments at the time f the snapsht r archive, match the current tenant assignment f the user s View permissin (even thugh there may have been changes in bth tenant assignments). Instance-based mdels are treated as rdinary CIs in terms f permissins. View CIs permissin enables a user t view such mdels (in a multi-tenancy envirnment) and Data Update permissin enables him t create, mdify, and delete them. In a multi-tenancy envirnment, View CIs permissin enables yu t view pattern-based mdels whse tenants match the tenant assignment fr the permissin. Yu are autmatically granted View permissin fr the queries n which the pattern-based mdels are based. Data Update permissin enables yu t create, mdify, and delete the mdels, but yu need update permissin fr the query t mdify it. T create a mdel based n a new query, yu must have Create Queries permissin fr the flder where the query will reside. T create a mdel based n an existing query, yu must have view permissin fr that query. If a user has Create Views permissin n a specific flder, he can create views in the flder based n existing TQL queries fr which he has view permissin as well as views based n HPE Universal CMDB (10.31) Page 269 f 300

270 Chapter 14: Rles Manager new queries. All permissins fr HPE Universal CMDB Cnfiguratin Manager are managed in the UCMDB Security mdules. Resurces Tab Permissins The fllwing table specifies the actins permitted fr the selected resurces by the Set Permissins ptins in the Resurces tab: Permissin Create View Update Delete Create Snapsht Archive Manage in CM Authrize in CM Actins Permitted Create resurces in the selected flders. View the selected queries, views, impact rules, custm reprts, r UCMDB Brwser widgets. Mdify the selected queries, views, impact rules, r custm reprts. Delete the selected queries, views, impact rules, r custm reprts. Create and view snapshts f the selected queries r views. Nte: Snapshts fr views can be created frm the UI. Snapshts fr queries can be created using the API. Archive the tplgy reprts f the selected views. Manage, unmanage, and edit the selected views in HPE Universal CMDB Cnfiguratin Manager. View and authrize changes t the selected views in HPE Universal CMDB Cnfiguratin Manager. Create permissin is nly relevant fr flders. If yu create a new resurce, yu can nly save it in a flder fr which yu have Create permissin. The ther permissins can be applied t individual resurces r t flders. When they are applied t a flder, they autmatically apply t all the resurces cntained in the selected flder. Fr example, View permissin fr a flder enables yu t view all the resurces cntained in that flder. HPE Universal CMDB (10.31) Page 270 f 300

271 Chapter 14: Rles Manager General Actins Permissins The fllwing table specifies the actins permitted by the different general actins permissins. Permissin Access t Authrized State Access t SDK Access t UCMDB Brwser Access t UI Administratin Allw Search Autmatin Executin Autmatin Plicies Autmatin Setup Class Mdel Mdifier Data Update Actins Permitted Access data in the authrized state. Run the Java API. Access the UCMDB Brwser UI. Access the UCMDB UI. Create users, grups, rles, resurce grups and assign rles t users and grups. Search fr CIs in the Search tab f the CI Selectr. Execute any Operatins Orchestratin flw in Cnfiguratin Manager (nly relevant fr HPE Universal CMDB Cnfiguratin Manager). Fr mre infrmatin, see "Autmatin Executin Dialg Bx" in the HPE Universal CMDB Cnfiguratin Manager User Guide. Define autmatin plicies in Cnfiguratin Manager (nly relevant fr HPE Universal CMDB Cnfiguratin Manager). Fr mre infrmatin, see "Autmatin Plicies" in the HPE Universal CMDB Cnfiguratin Manager User Guide. Cnfigure Operatins Orchestratin flws in Cnfiguratin Manager (nly relevant fr HPE Universal CMDB Cnfiguratin Manager). Fr mre infrmatin, see "Autmatin Setup" in the HPE Universal CMDB Cnfiguratin Manager User Guide. Add, delete, and update CI types in the CI Type Manager. Create, update, and delete CIs and relatinships. HPE Universal CMDB (10.31) Page 271 f 300

272 Chapter 14: Rles Manager Permissin Deply Packages Get Related CIs Gld Master Archive Plicies Admin Reassign Tenant Actins Permitted Deply packages in Package Manager. Access the Related CIs functinality. Archive a Gld Master reprt. Create, edit, and delete baseline, tplgy, and similarity plicies in HPE Universal CMDB Cnfiguratin Manager. Change the tenant assignment fr a resurce r CI in the Assign Tenants dialg bx. Nte: This permissin is nly available when multi-tenancy is enabled. Remte Deplyment Run Discvery and Integratins View Discvery Status and Errr Run Impact Analysis Run Legacy API Run Query by Definitin Service Mdeling Settings Deply a package that exists n the lcal UCMDB t a remte UCMDB server that is defined by the selected integratin pint. Run discvery in the Universal Discvery mdule and integratins in the Integratin Studi. View discvery status and errrs f a CI in IT Universe Manager when the Shw Discvery Prgress permissin is als enabled. Or, view discvery status and errrs f a CI in Universal Discvery mdule when bth the Shw Discvery Prgress permissin and the Universal Discvery mdule are enabled. Run Impact Analysis in the IT Universe Manager. Run the client APIs. Preview a view in the Mdeling Studi. Create service mdels in the UCMDB Brwser. Update the infrastructure settings using the API. HPE Universal CMDB (10.31) Page 272 f 300

273 Chapter 14: Rles Manager Permissin Actins Permitted Management View CIs View CIs. Nte: This permissin is nly available when multi-tenancy is enabled. View Histry View Recipients View Tenant Assignment View UI Scheduler Jbs View CI histry. View recipients in the Recipients Manager. View the tenant assignment fr a resurce r CI in the Assign Tenants dialg bx. Nte: This permissin is nly available when multi-tenancy is enabled. View Scheduler jbs in the Scheduler. Out-f-the-Bx Rles The fllwing rles are prvided ut-f-the-bx by UCMDB fr assigning t different users: DataCnsumer. Read nly permissin fr resurces and CIs and access t IT Universe Manager and the Reprts mdule nly. Discvery and Integratins Admin. Full permissin fr all Data Flw Management mdules, withut tenant assignment permissins. Includes permissins fr all actins that are required t perfrm any discvery-related flws and t deply packages n remte integratin pints. It als includes permissin fr discvery-related tasks such as managing prbes, credentials, and adapters and fr viewing discvery-related reprts. SuperAdmin. All permissins fr all mdules. When multi-tenancy is nt enabled, the fllwing additinal ut-f-the-bx rles are available: Viewer. Read nly permissin fr resurces and CIs and access t all Mdeling mdules except fr Enrichment Manager, withut tenant assignment permissin (nly relevant when multi-tenancy is nt enabled). Admin. Full permissin fr resurces and CIs and access t all Mdeling mdules except fr Enrichment Manager, withut tenant assignment permissin (nly relevant when multi-tenancy is HPE Universal CMDB (10.31) Page 273 f 300

274 Chapter 14: Rles Manager nt enabled). Als includes all permissins assciated with HPE Universal CMDB Cnfiguratin Manager. When multi-tenancy is enabled, the fllwing additinal ut-f-the-bx rles are available: TenantViewer. Read nly permissin fr resurces and CIs and access t all Mdeling mdules except fr Enrichment Manager. Als includes read nly permissin fr tenant assignment (nly relevant when multi-tenancy is enabled). TenantAdmin. Full permissin fr resurces and CIs and access t all Mdeling mdules except fr Enrichment Manager, including tenant assignment permissin (nly relevant when multi-tenancy is enabled). Nte: Out-f-the-bx rles cannt be edited r deleted. HPE Universal CMDB (10.31) Page 274 f 300

275 Chapter 15: Resurce Grups This chapter includes: Resurce Grups Overview 275 Hw t Define a Resurce Grup 275 Resurce Grups User Interface 276 Resurce Grups Overview A resurce grup is a cllectin f resurces that yu define fr the purpse f assigning permissins t users. The Resurce Grups mdule enables yu t select specific resurces f different types and define the cllectin as a resurce grup. When yu assign permissins t rles in the Rles Manager, yu can select a resurce grup, alng with specific actins, as the permissin fr that rle. This can be useful when yu need t assign permissins fr the same cllectin f resurces t several different rles. There is ne default, ut-f-the-bx resurce grup, the All Resurces Grup, which includes all the existing resurces. This resurce grup cannt be edited r deleted. Fr details n defining resurce grups, see "Resurce Grups Page" n page 277. Nte: The Resurce Grups mdule is available nly t thse lgged in with administratin access rights. Hw t Define a Resurce Grup The fllwing task describes hw t define a new resurce grup: 1. Create a New Resurce Grup Click the New Resurce Grup buttn in the Resurce Grups pane t pen the New Resurce Grup dialg bx. Enter a name and descriptin fr yur resurce grup. Fr details, see "New Resurce Grup Dialg Bx" n the next page. HPE Universal CMDB (10.31) Page 275 f 300

276 Chapter 15: Resurce Grups 2. Select Resurces In each tab, select the resurces yu want t include in the resurce grup. Fr details, see "Resurce Grups Page" n the next page. Nte: Select the All Resurces check bx t include all the resurces f the tab in the resurce grup, including resurces f the selected type created in the future. 3. Save the Resurce Grup Click the Save buttn in the Resurce Grups pane t save yur changes. Resurce Grups User Interface This sectin includes (in alphabetical rder): New Resurce Grup Dialg Bx 276 Resurce Grups Page 277 New Resurce Grup Dialg Bx This dialg bx enables yu t define a new resurce grup. T access Click the New Resurce Grup buttn in the Resurce Grups pane. Relevant tasks See als "Hw t Define a Resurce Grup" n the previus page "Resurce Grups Overview" n the previus page User interface elements are described belw (unlabeled elements are shwn in angle brackets): UI Element (A-Z) Descriptin Resurce grup name Descriptin Enter a descriptin f the resurce grup yu are defining. Enter a unique name fr the resurce grup. HPE Universal CMDB (10.31) Page 276 f 300

277 Chapter 15: Resurce Grups Resurce Grups Page This page enables yu t create, edit, and delete resurce grups. T access Imprtant infrmatin Relevant tasks Select Resurce Grups frm the Security mdule n the Navigatin Menu r select Managers > Security > Resurce Grups. Select a resurce grup in the Resurce Grups pane and select the specific resurces t include in the grup frm the resurce tabs in the right pane. "Hw t Define a Resurce Grup" n page 275 See als "Resurce Grups Overview" n page 275 Resurce Grups Pane User interface elements are described belw (unlabeled elements are shwn in angle brackets): UI Element (A-Z) Descriptin New Resurce Grup. Creates a resurce grup. Opens the New Resurce Grup dialg bx. Edit Resurce Grup. Enables yu t edit the name f the selected resurce grup. Delete. Remves the selected resurce grup(s). Nte: Yu can make multiple selectins t delete multiple resurce grups. Refresh. Refreshes the list f resurce grups. Save. Saves the changes yu have made. Save As. Saves the resurce grup with a different name. <List f resurce grups> Cntains the names f the existing resurce grups. HPE Universal CMDB (10.31) Page 277 f 300

278 Chapter 15: Resurce Grups UI Element (A-Z) <Search feature> Descriptin T search fr a phrase in the list f resurce grups, enter the phrase in the Find bx. Use the arrw buttns t find the next and previus ccurrences f the phrase. Click the Highlight buttn t highlight all ccurrences f the phrase. Right Pane Imprtant infrmatin The tabs represent different resurces. The fllwing tabs are available: Queries Views Impact Analysis Custm Reprts UI Mdules UCMDB Brwser Widgets In each tab, use the arrw buttns t mve resurces frm the Available Resurces pane t the Selected Resurces pane. Yu can mve individual resurces r flders cntaining resurces. User interface elements are described belw: UI Element (A-Z) All Resurces Descriptin Select All Resurces t mve all available resurces t the Selected Resurces pane. Nte: Selecting this ptin ensures that resurces f the selected type that are created in the future are als included in the Selected Resurces. Available Resurces Selected Resurces Displays the available resurces fr the selected tab. Displays the selected resurces fr the selected tab. HPE Universal CMDB (10.31) Page 278 f 300

279 Chapter 16: Ownership Management This chapter includes: Ownership Management Overview 279 Ownership Management User Interface 279 Ownership Management Overview The Ownership Management mdule prvides a directry f resurces and their user wners. The user wner is autmatically defined as the user lgged in at the time the resurce is created. The user wner f a resurce cannt be changed, but yu can delete the wnership f resurce. In such a case, the resurce remains withut a user wner. When wrking in a multi-tenancy envirnment, nte that resurce wnership is independent f tenancy. Fr details n multi-tenancy, see "Multi-Tenancy Overview" n page 226. Nte: The Ownership Management mdule is available nly t thse lgged in with administratin access rights. Ownership Management User Interface This sectin includes: Ownership Management Page 279 Ownership Management Page This page enables yu t view the resurce wnership data and t delete the wnership fr a resurce. T access See als Select Ownership Management frm the Security mdule n the Navigatin Menu r select Managers > Security > Ownership Management. "Ownership Management Overview" abve HPE Universal CMDB (10.31) Page 279 f 300

280 Chapter 16: Ownership Management User interface elements are described belw: UI Element (A-Z) Descriptin Delete Selected Item(s). Remves the wnership frm the selected resurce. Yu can make multiple selectins. Refresh displayed data. Refreshes the list f resurces. Clear Filter. Clears the text entered in any f the filters. Resurce Name Resurce Type User Name Enter a resurce name t filter the displayed resurces by name. Select a resurce type frm the drp dwn list t filter the displayed resurces by type. Select a user name frm the drp dwn list t filter the displayed resurces by user wner. HPE Universal CMDB (10.31) Page 280 f 300

281 Chapter 17: LDAP Mapping Chapter 17: LDAP Mapping This chapter includes: LDAP Mapping Overview 281 Synchrnize Universal CMDB User Grups with LDAP Grups 282 Hw t Cnfigure LDAP fr Active Directry 283 Search LDAP Users 285 LDAP Mapping User Interface 287 LDAP Mapping Overview When using an LDAP server t authrize users, it is necessary t map user grups n the LDAP server t user grups in Universal CMDB. Yu can assciate Universal CMDB grups with LDAP grups using the LDAP Mapping mdule in the Security sectin f the Navigatin bar. The LDAP Mapping mdule nly appears if the user has the required permissins. Fr details, see "Rles Manager" n page 259. Fr details n synchrnizing LDAP grups with Universal CMDB grups, see "Synchrnize Universal CMDB User Grups with LDAP Grups" n the next page. Fr details n cnfiguring LDAP authenticatin, see the sectin n enabling LDAP authenticatin in the HPE Universal CMDB Hardening Guide. Nte: Yu must cnfigure LDAP mapping fr bth the actual and authrized states. UCMDB can be cnfigured t wrk with every LDAP server which implements the standard LDAP prtcl. HPE recmmends t set the Passwrds must use default plicy infrastructure setting t False when LDAP authenticatin is enabled. LDAP security plicies shuld be used if LDAP is enabled. HPE Universal CMDB (10.31) Page 281 f 300

282 Chapter 17: LDAP Mapping Synchrnize Universal CMDB User Grups with LDAP Grups This task describes hw t synchrnize LDAP user grups with Universal CMDB user grups: 1. Cnfigure an LDAP synchrnizatin strategy a. G t JMX Cnsle > UCMDB:service=LDAP Services > cnfigureldapserver, enter the values fr the relevant settings, and click Invke. Fr details, see "Hw t Define LDAP Servers and Enable the LDAP Authenticatin" in the HPE Universal CMDB Hardening Guide. b. G t UCMDB > Managers > Administratin > Infrastructure Settings, select LDAP General, and set the Enable User Permissins Synchrnizatin and the Remte users repsitry settings t True. Nte: Any changes yu make fr LDAP General > Remte users repsitry and LDAP General > Enable User Permissins Synchrnizatin remain in effect fr all future Web sessins. c. Select Managers > Security > LDAP Mapping and verify that the list f the LDAP grups that are cnfigured n the LDAP server appear in the LDAP Repsitry pane. If the list f LDAP grups d nt appear, verify yur LDAP settings. Fr details n Infrastructure Settings, see "Infrastructure Settings Manager Overview" n page Create Universal CMDB grups Yu can create Universal CMDB user grups and assign rles t them. Fr details n creating grups, see "Users and Grups" n page Map LDAP grups t Universal CMDB grups Yu map user grups n the LDAP server t grups in Universal CMDB t synchrnize the grups and enable management f yur Universal CMDB grups via the LDAP server, as fllws: a. Select Managers > Security > LDAP Mapping. b. In the LDAP Repsitry pane, select a remte grup. c. Mve the required grups frm the Available grups pane t the Selected grups pane using the arrw buttns r by dragging and drpping the required grups int the Selected grups HPE Universal CMDB (10.31) Page 282 f 300

283 Chapter 17: LDAP Mapping pane. d. Click Save. Cautin: When defining mappings, make sure t map at least ne LDAP grup t an Admin grup in the CMDB befre lgging ut. If this is nt dne, yu may nt have any remaining grup with administratin permissins. 4. Lg ut and lg in t Universal CMDB a. Select LDAP General > Enable LDAP authenticatin and set the value t True. b. Lg ut f Universal CMDB and then lg in again with the LDAP user name and passwrd. Hw t Cnfigure LDAP fr Active Directry This task describes hw t cnfigure LDAP fr Active Directry. T enable LDAP lgin and user permissins synchrnizatin, edit the fllwing parameters in JMX cnsle > UCMDB:service=LDAP Services > cnfigureldapserver methd: Nte: Fr all ther parameters, yu can use either the default values r, if required, LDAP-specific values. LDAP Integratin Settings LDAP search user Cmment CN=AD Cnnectr CN=Users DC=cnsult DC=example DC=cm Enable User Permissins Synchrnizatin Grup class true: Enables permissin synchrnizatin fr LDAP grup mapping with Universal CMDB user grups (when Enable LDAP Authenticatin is set t true). grup HPE Universal CMDB (10.31) Page 283 f 300

284 Chapter 17: LDAP Mapping LDAP Integratin Settings Cmment bject Grups base DN CN=Users DC=cnsult DC=example DC=cm Grups member attribute Grup base filter member ( (bjectclass=grupofnames) (bjectclass=grup) (bjectclass=grupofuniquenames)(bjectclass=grupofurls) (bjectclass=access Grup)(bjectclass=accessRle)) LDAP URL Passwrd f Search-Entitled User Remte users repsitry mde Rt grup The URL t yur LDAP server, including prt: ldap://ldap-server:389/ DC=cnsult,DC=example, DC=cm??sub ***** Enable LDAP authenticatin. Defines the parent LDAP nde f all users t be synchrnized. A Synchrnizatin User List base DN includes all users in that DN unless the users are excluded by the Synchrnizatin User List's filter r the user's DN is matched in a mre specific Synchrnizatin User List. CN=Users DC=cnsult DC=example HPE Universal CMDB (10.31) Page 284 f 300

285 Chapter 17: LDAP Mapping LDAP Integratin Settings Cmment DC=cm Rt grups filter ( (bjectclass=grupofnames) (bjectclass=grup) (bjectclass=grupofuniquenames)(bjectclass=grupofurls) (bjectclass=access Grup)(bjectclass=accessRle)) Users filter Defines an LDAP filter used t include r exclude users frm a Synchrnizatin User List: (&(samaccuntname=*) (bjectclass=user)) Users bject class UUID attribute (User Unique ID attribute) user samaccuntname Search LDAP Users The JMX cnsle prvides a getldapgrupuserschunk() methd that allws yu t search LDAP users. The methd returns matched users in ne r multiple chunks, and each chunk cntains 100 users at mst. Nte: T search LDAP users, the LDAP server must supprt Virtual List View (VLV) and Server Side Srting. Fllw these steps t search LDAP users frm the JMX cnsle: 1. Launch yur web brwser and enter the fllwing address: where <server_name> is the name f the machine n which HPE Universal CMDB is installed. HPE Universal CMDB (10.31) Page 285 f 300

286 Chapter 17: LDAP Mapping Yu may need t lg in with a user name and passwrd. 2. Under UCMDB, click UCMDB:service=LDAP Services t pen the Operatins page. 3. Lcate getldapgrupuserschunk, and then specify the fllwing parameters. Parameter ldaphst Value Enter the hst name f the LDAP server. This parameter is mandatry. searchingrup Enter the grup's name if yu want t search in a specific grup. Default: search all grups. searchbyfield Specify ne f the fllwing fields: uid, displayname. The methd then searches in the specified field. Default:uid. searchvalue srtbyfield Enter the search value. Specify ne f the fllwing fields: uid, displayname. The methd then srts the search result by the specified field. Default:uid. srtorder Specify the srt rder f the search result. Default: True (in ascending rder). requestedchunknumber Specify which chunk f result that the methd returns. Default: the first chunk. multiplechunksrequest Specify hw many chunks f result that the methd returns. The methd returns the specified number f chunks starting frm the first chunk. This parameter wrks nly when requestedchunknumber is nt specified. Otherwise, the methd nly returns the chunk as specified in requestedchunknumber. Nte: If nly ldaphst is specified, the methd returns the first chunk f all users in all grups in the ascending rder f the uid field. 4. Click Invke. HPE Universal CMDB (10.31) Page 286 f 300

287 Chapter 17: LDAP Mapping Nte: The methd can return the grup infrmatin f LDAP users. T enable this functinality, yu need t cnfigure the LDAP server by using the cnfigureldapserver() methd and set the displayusersgrup parameter t True. LDAP Mapping User Interface This sectin includes: LDAP Grups t UCMDB Grups Mappings Dialg Bx 287 LDAP Mapping Page 287 Remte Grup Users Dialg Bx 289 LDAP Grups t UCMDB Grups Mappings Dialg Bx This dialg bx displays all the LDAP user grups that have been mapped t Universal CMDB user grups. T access Click the Shw LDAP Grups t UCMDB Grups Mapping tlbar. buttn n the See als "LDAP Mapping Overview" n page 281 User interface elements are described belw: UI Element (A- Z) Descriptin LDAP Grup UCMDB Grups The name f the LDAP user grup. The Universal CMDB user rles that are mapped t the crrespnding LDAP grup. LDAP Mapping Page This page enables yu t map grups cnfigured in Universal CMDB t grups cnfigured n the LDAP server. T access Select LDAP Mapping frm the Security mdule n the Navigatin Menu r select Managers > Security > LDAP Mapping. HPE Universal CMDB (10.31) Page 287 f 300

288 Chapter 17: LDAP Mapping Relevant tasks "Hw t Cnfigure LDAP fr Active Directry" n page 283 "Synchrnize Universal CMDB User Grups with LDAP Grups" n page 282 See als "LDAP Mapping Overview" n page 281 User interface elements are described belw: UI Element (A-Z) Descriptin Save Mapping. Saves yur changes t the LDAP mapping. Shw Users. Enables yu t view the list f users assciated with the selected LDAP grup. Opens the Remte Grup Users dialg bx. Nte: Yu can als select this ptin by right-clicking a grup. Shw LDAP Grups t UCMDB Grups Mappings. Displays the LDAP grups that have been mapped t UCMDB grups. Tggle between displaying all LDAP grups and displaying nly grups with mapped UCMDB grups. Drp-dwn list f LDAP servers Allws yu t select an LDAP server frm multiple LDAP servers. Nte: This drp-dwn list is available nly when multiple LDAP servers are cnfigured. LDAP Repsitry Pane UI Element (A-Z) <LDAP Grups Tree> Descriptin Displays a list f the LDAP grups that are cnfigured n the LDAP server in tree frmat. Nte: Begin typing the name f the required grup t search fr it in the tree. UCMDB Grups Fr LDAP Grup: <grup name> Pane This enables yu t select the Universal CMDB grups t map t the selected LDAP grup. User interface elements are described belw: HPE Universal CMDB (10.31) Page 288 f 300

289 Chapter 17: LDAP Mapping UI Element (A-Z) Available Grups Selected Grups Descriptin Displays the available UCMDB grups. Displays the UCMDB grups selected fr mapping t the selected LDAP grup. Remte Grup Users Dialg Bx This dialg bx displays all the users in the selected LDAP grup. T access Click the Shw Users buttn n the tlbar. See als "LDAP Mapping Overview" n page 281 User interface elements are described belw: UI Element (A-Z) Lgin Name User Name Descriptin Displays the lgin names f the users in the grup. Displays the user names f the users in the grup. HPE Universal CMDB (10.31) Page 289 f 300

290 Chapter 18: Tenants Management This chapter includes: Tenants Management Overview 290 Multi-Tenancy Architecture vs. Multi-Custmer Architecture 290 Mdeling in a Multi-Tenant Envirnment 296 Hw Scheduler Runs in a Multi-Tenant Envirnment 296 Tenants Management User Interface 297 Nte: The Tenants Management mdule is nly available when multi-tenancy is enabled. This ptin is enabled when installing/upgrading UCMDB. A multi-tenancy envirnment cannt be recnfigured as a single tenancy envirnment. Tenants Management Overview The Tenants Management mdule enables yu t manage yur tenants. Yu can add new tenants, delete tenants, and edit existing tenants. Fr details n multi-tenancy, see "User Permissins fr UCMDB" n page 221. Nte: The Tenants Management mdule is available nly t thse lgged in with administratin access rights. Multi-Tenancy Architecture vs. Multi-Custmer Architecture This sectin highlights the differences between the multi-custmer and multi-tenant architectures in UCMDB. While the terms custmer and tenant may in sme cases be interchangeable, in UCMDB jargn they represent tw different slutins, which will be explained belw. HPE Universal CMDB (10.31) Page 290 f 300

291 Chapter 18: Tenants Management Multi-Custmer (MC) Architecture In the MC architecture each custmer has its wn data mdel (CIs) and class mdel (CITs). The data is segregated int different tables, ne table (fr each CIT) per custmer. HPE Universal CMDB (10.31) Page 291 f 300

292 Chapter 18: Tenants Management This mdel is very efficient in handling disparate data mdels that have few (if any) CIs in cmmn. Fr such scenaris this is the mst scalable slutin because each custmer s data mdel is islated t its wn (smaller and mre manageable) DB tables. The dwnside f the MC architecture is that multiple custmers' data cannt be viewed in a unified view (fr example, yu cannt execute a TQL query in the UCMDB UI and receive the data frm bth custmer 1 and custmer 2). A typical scenari fr using the MC architecture wuld be a SaaS (Sftware as a Service) deplyment where ne UCMDB stres data fr multiple unrelated custmers. Multi-Tenant (MT) Architecture The MT architecture is designed t prvide a lgical separatin f the data mdel int tenants. With the data mdel and the class mdel stred in UCMDB, the MT slutin tags each CI and resurce (TQL query, View) as being wned/used by certain tenants. In such a slutin all the Windws CIs in UCMDB will be stred in the same table (CDM_NT_1) and there is an extra cnstruct which keeps track f each CI s wning and using tenants. When a query is executed (fr example, by User 1, which is assigned t Tenant 1 and Tenant 2), the result sent by UCMDB is given by all the CIs that match the query, filtered by the cnditin that each CI shuld be assciated t Tenant 1 r Tenant 2. HPE Universal CMDB (10.31) Page 292 f 300

293 Chapter 18: Tenants Management A typical scenari fr the MT architecture wuld be a Managed Service Prvider s UCMDB deplyment in which many CIs belng t the Managed Service Prvider (MSP) (the cre infrastructure), and these cre CIs are als used by the specific infrastructure that is dedicated t certain custmers f the MSP. Fr example, as shwn belw, we may have 3 tenants defined in UCMDB: MSP, Tenant 1 and Tenant 2. The MSP tenant cvers the entire data mdel while Tenant 1 and Tenant 2 have access t disjint CI sets frm the MSP s data mdel. Here is a sample CI tplgy in this envirnment: HPE Universal CMDB (10.31) Page 293 f 300

294 Chapter 18: Tenants Management Thrugh the crrect tenant assciatins UCMDB can ensure that users f the MSP can see all the CIs, while users f Tenant 1 can nly see Tenant 1 s data center. The key bservatin here is that it is pssible fr a Running Sftware f Tenant 1 and anther Running Sftware f Tenant 2 t depend n the same cre infrastructure CIs belnging t the MSP. These dependencies can be mdeled in a MT UCMDB and running an impact analysis n the shared infrastructure CIs will reveal t the MSP administratrs that the 2 Running Sftware CIs f Tenant 1/Tenant 2 are impacted. Such flexibility is impssible t achieve in the MC architecture which separates CIs int different data mdels. Multi-Tenant Architecture with Tenant-Aware Recnciliatin UCMDB (since versin 10.21) supprts a new setting recnciliatin.tenantaware.citypes that ensures CIs f the types defined in the setting cannt be matched t CIs with different tenant wners. HPE Universal CMDB (10.31) Page 294 f 300

295 Chapter 18: Tenants Management This nly affects CIs that inherit frm the CI types declared in the setting. By checking the Tenant Owner as a verificatin criterin during recnciliatin, a MT UCMDB can behave similarly t a MC UCMDB, because data reprted fr Tenant 1 will nt be able t merge with data reprted fr Tenant 2 even if all ther attributes are equal. There are a few cnsideratins when implementing such a slutin: 1. In such a cnfiguratin data reprted frm Tenant 1 and Tenant 2 shuld never need t be merged in ther wrds, there shuld be n valid use-case where Tenant 1 and Tenant 2 data have cmmn, shared CIs as shwn in the MSP example. 2. The ther cnsideratin is whether the tenant-aware recnciliatin shuld be dne acrss all CIs in UCMDB (simulating the MC apprach) r whether tenant-aware recnciliatin shuld be dne nly fr a certain CI type (which wuld result in a hybrid apprach) either can be achieved thrugh the right selectin f the CI types declared in the setting (tenant aware recnciliatin CITs, final name TBD) Migratin frm Single-Tenant Architecture t Multi- Tenant r Multi-Custmer Architecture This sectin describes whether the fllwing migratin scenaris are pssible and the required steps fr each scenari. Migratin frm the standard (Single-Tenant) architecture t Multi-Tenant (MT) architecture is nt pssible at the mment. It requires reinstall. Migratin frm the standard (Single-Tenant) architecture t Multi-Custmer (MC) architecture is pssible. Yu just need t call the JMX methds that are used t add custmers. Migratin frm MT t MC r frm MC t MT is pssible by integrating tw UCMDB servers (ne MT, the ther MC) and running a UCMDB t UCMDB integratin between them. There is n supprt t directly switch a UCMDB server frm ne architecture t the ther. Prbe Cnnectin Address in MT and MC Architectures In bth MT and MC architecture, the prbe is cnnecting t the same address as when cnnecting t a standard system. The nly difference is as fllws: In MT, the tenant is cnfigured t be reprted n the prbe. In MC, the custmer is cnfigured t be reprted n the prbe. HPE Universal CMDB (10.31) Page 295 f 300

296 Chapter 18: Tenants Management Mdeling in a Multi-Tenant Envirnment A user can link a mdel CI t CIs n which the user has the View permissin. As shwn in the fllwing diagram, UserX has the Update permissin n tenant 1 (T1) and the View permissin n tenant 2 (T2), and the CIs (H0 H6) have different tenant assciatins. UserX can make the linkages as shwn belw. When yu assign a tenant n a pattern-based mdel frm the Mdeling Studi, the tenant will be assigned t bth the pattern-based mdel and the enrichment business view definitin. If yu assign a tenant frm the IT Universe Manager, the tenant will nly be assigned t the patter-based mdel, and will be verridden in 12 hurs during the next pattern-based mdel calculatin. The permissins fr a pattern-based mdel are checked in the cntext f tenants assigned t bth the pattern-based mdel and the enrichment definitin. Hw Scheduler Runs in a Multi-Tenant Envirnment The scheduler n a Multi-Tenant envirnment runs in the cntext f the user s tenant wner and calculates data frm available tenants set as cnsumers. Fr the admin and sysadmin user, the scheduler runs in the cntext f the System Default Tenant and calculates data that can be cnsumed by all tenants. A pattern-based mdel created by a custm tenant is wned by that custm tenant and n calculatin gets results frm all available tenants that are set as cnsumers fr this pattern-based mdel. Scheduler fr this pattern-based mdel runs in the cntext f the custm tenant and the business enrichment calculatin will have result CIs frm tenants allwed t be cnsumed by this user. Yu can check the tenant wner and tenant cnsumer t deduct the cntext that the scheduler runs. This infrmatin is available in the Assign Tenant dialg bx fr the pattern-based mdel. The scheduler des nt cnsider the CIs that have n tenant during the calculatin. If sme CIs have n tenant wner r tenant cnsumer, even if a user can see the related result frm the UI, the result f the scheduler will be different. HPE Universal CMDB (10.31) Page 296 f 300