HP Integrations - HPE Software Documentation Portal

HP Universal CMDB
Software Version: Content Pack 17.00 (CP17)
Universal Discovery Content Guide - HP Integrations
Document Release Date: Feburary 2017 (Second Edition)
Software Release Date: September 2015
Universal Discovery Content Guide - HP Integrations
Legal Notices
Warranty
The only warranties for HP products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be
construed as constituting an additional warranty. HP shall not be liable for technical or editorial errors or omissions contained herein.
The information contained herein is subject to change without notice.
Restricted Rights Legend
Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software,
Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license.
Copyright Notice
© 2002 - 2015 Hewlett-Packard Development Company, L.P.
Trademark Notices
Adobe™ is a trademark of Adobe Systems Incorporated.
Microsoft® and Windows® are U.S. registered trademarks of Microsoft Corporation.
UNIX® is a registered trademark of The Open Group.
Documentation Updates
The title page of this document contains the following identifying information:
l
l
l
Software Version number, which indicates the software version.
Document Release Date, which changes each time the document is updated.
Software Release Date, which indicates the release date of this version of the software.
To check for recent updates or to verify that you are using the most recent edition of a document, go to: https://softwaresupport.hp.com/.
This site requires that you register for an HP Passport and to sign in. To register for an HP Passport ID, click Register on the HP Support site or click Create an Account on the
HP Passport login page.
You will also receive updated or new editions if you subscribe to the appropriate product support service. Contact your HP sales representative for details.
Support
Visit the HP Software Support site at: https://softwaresupport.hp.com.
This website provides contact information and details about the products, services, and support that HP Software offers.
HP Software online support provides customer self-solve capabilities. It provides a fast and efficient way to access interactive technical support tools needed to manage your
business. As a valued support customer, you can benefit by using the support website to:
l
l
l
l
l
l
l
l
Search for knowledge documents of interest
Submit and track support cases and enhancement requests
Download software patches
Manage support contracts
Look up HP support contacts
Review information about available services
Enter into discussions with other software customers
Research and register for software training
Most of the support areas require that you register as an HP Passport user and to sign in. Many also require a support contract. To register for an HP Passport ID, click
Register on the HP Support site or click Create an Account on the HP Passport login page.
To find more information about access levels, go to: https://softwaresupport.hp.com/web/softwaresupport/access-levels.
HP Software Solutions Now accesses the HPSW Solution and Integration Portal website. This site enables you to explore HP Product Solutions to meet your business needs,
includes a full list of Integrations between HP Products, as well as a listing of ITIL Processes. The URL for this website is http://h20230.www2.hp.com/sc/solutions/index.jsp.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 2 of 366
Contents
Chapter 1: HP APM Push Integration
15
Overview
15
How Data is Synchronized Between HP APM and UCMDB
16
Supported Versions
17
How to Integrate UCMDB and HP APM
17
Deploy the APM Push Adapter
17
Create an Integration Point between HP APM and UCMDB
18
(Optional) Push CI Data from UCMDB to HP APM
22
Schedule Data Push Jobs
26
View UCMDB Data in HP APM
27
Customize the Integration
27
Overview
28
Customize an Existing Mapping
28
Add a New Mapping to the Integration
29
Developer References
32
Adapter
32
Default Entity and Field Mappings between HP APM and UCMDB
33
Default Field Mappings between HP APM Application and UCMDB BusinessApplication
34
Default Field Mappings between HP APM Process and UCMDB BusinessProcess
36
Default Field Mappings between HP APM Location and UCMDB Location
37
Default Field Mappings between HP APM Server and UCMDB Node
38
REST APIs Called in the Integration
39
Delete a Request
39
Troubleshooting and Limitations
41
Limitations
Chapter 2: HP Asset Manager Population Integration
41
45
Overview
47
Supported Versions
47
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 3 of 366
Universal Discovery Content Guide - HP Integrations
How to Integrate Asset Manager with UCMDB
47
Verify UCMDB to AM Configuration
52
What CI data is populated from AM to UCMDB?
53
Population TQLs
53
Criteria for AM records to be propagated
54
What is created in UCMDB during population?
58
Reconciliation
58
What happens when changes occur in AM during data population?
59
Supported CI Types
59
Supported CI attributes and the mapping with the AM fields
60
CI Type: Asset
60
CI Type: IpAddress
60
CI Type: Node
61
CI Type: CPU
62
CI Type: DiskDevice
62
CI Type: FileSystem
63
CI Type: InstalledSoftware
63
CI Type: Interface
63
CI Type: LogicalVolume
64
CI Type: Printer
64
CI Type: Location
64
CI Type: BusinessElement
64
The configuration files used by the integration
Where are the configuration files located
66
66
discriminator.properties
66
server_virtual_distinguisher.properties
66
server_desktop_distinguisher.properties
67
fixed_values.txt
68
location_type_transformer.xml
68
condition_rules.xml
69
Global_id_mapping.properties
70
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 4 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
71
Quick Start
72
Overview
72
Supported Versions
74
How to Integrate UCMDB and Asset Manager
75
Validate Pre-Loaded Data in Asset Manager
75
Set Up Asset Manager
75
Set Up UCMDB
80
Push CI Data from UCMDB to Asset Manager
83
How to View UCMDB Data in Asset Manager
89
Nodes
89
Business Elements
90
How to Schedule Data Push Jobs
90
Installed Software / Software Utilization
92
How to Tailor the Integration
95
Integration Architecture
96
Data Flow Architecture
96
Integration TQL Queries
97
Reconciliation Proposals
97
Asset Manager Rules and Flows
98
Data Mapping
98
Push Mapping
99
Basic Information
99
Reconciliation
100
Target CI Validation
102
Reference Attribute
103
Attribute Reconciliation
103
Action on Delete
104
Enum Attribute
104
Ignored Attributes
105
How to Change Adapter Settings
105
How to Customize an Existing Mapping
107
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 5 of 366
Universal Discovery Content Guide - HP Integrations
How to Add a New Mapping to the Integration
109
Frequently Asked Questions
112
Troubleshooting and Limitations
116
Logs
121
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
122
Overview
123
Supported Versions
124
Architecture
124
How to Integrate UCMDB and Asset Manager
125
HP Asset Manager Setup
125
Validate Pre-Loaded Data in Asset Manager
125
Create an Account with Administrative Rights
126
Update Asset Manager Schema
127
Activate Workflows for Population
128
Prepare Asset Manager for Parallel Push
128
Create Asset Manager API Zip Package
130
HP UCMDB Setup
130
Deploy Asset Manager API Zip Package
130
Install a Database Client
130
Create an Integration Point in UCMDB
132
Out-of-Box Integration Jobs
134
Asset Manager Population Jobs
135
Asset Manager Push Jobs
136
Asset Manager Federation Configuration
143
Verify Out-of-Box Population and Push Jobs
144
Synchronize Data between UCMDB and Asset Manager
145
How to View UCMDB Data in Asset Manager
146
Nodes
146
Business Elements
147
How to View Asset Manager Data in UCMDB
147
How to Federate Asset Manager Data in UCMDB
147
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 6 of 366
Universal Discovery Content Guide - HP Integrations
Integration Jobs Configuration
149
How to Schedule Data Integration Jobs
150
Edit Data Integration Jobs
150
Standards and Concepts
152
Asset Manager Entity
152
Asset Manager Entity Definition Steps
153
Import Tables and Entity Definition
153
Out-of-Box Entity Definition
155
UCMDB TQL
157
Groovy Functions
158
Basic Functions
158
AM Population Groovy
158
AM Push Groovy
159
Utility Functions
163
Reconciliation Functions
164
Data Mapping Schema
164
Population and Federation
166
Criteria for Asset Manager Records to be Populated
166
Transformation for Asset Manager Records to be Populated
167
Reconciliation
170
Population Condition and Push Back Definition
170
Built-in attributes from AM
171
Federation Tags
171
Population Tags
172
Push and Reconciliation
172
Data Flow Architecture
172
Integration TQL Queries
173
Reconciliation Proposals
174
Asset Manager Rules and Flows
175
Mapping Attributes
175
Reconciliation
176
Target CI Validation
178
Reference Attribute
179
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 7 of 366
Universal Discovery Content Guide - HP Integrations
Attribute Reconciliation
179
Action on Delete
180
Enum Attribute
180
Ignored Attributes
181
Deletion
181
Population Deletion Configuration
181
Push Deletion Configuration
183
Installed Software / Software Utilization
184
Mapping UI
186
How to Tailor the Integration
189
How to Change Adapter Settings
189
How to Customize an Existing Mapping
191
How to Add a New Mapping to the Integration
195
How to Populate Asset Manager Contract
197
How to Set up Federation
204
How to Set up Integration in a Multi-Tenant Environment
205
Viewing tenant list in UCMDB
206
View tenant list in Asset Manager
206
Define a tenant for data pushed into UCMDB
206
Default owner name in the integration point
207
Set AQL query condition in am-populate-config.xml
207
Matrix and solution brief
208
Performance Tuning and Best Practice
211
Chunk Size
211
Time out
211
TQL Tailoring
212
Push Mapping Simplification
212
Global ID
213
Population Mapping Optimization
214
Migration Guide
Differences between Old Push Adapter and Push in Generic Adapter
Mapping Schema Changes
HP Universal CMDB (Content Pack 17.00 (CP17))
214
214
215
Page 8 of 366
Universal Discovery Content Guide - HP Integrations
File Renaming and reorganizing
215
Asset Manager Entity Reference in Mapping Script and Reconciliation
215
Differences between Old Population Adapter and Population in AM Generic Adapter
216
No need to import views for AM database
216
Population mapping needs to specify TQL
216
Attributes conversion and discrimination
216
Frequently Asked Questions
217
Troubleshooting and Limitations
221
Logs
224
AM API Logs
224
Chapter 5: HP Configuration Manager - Federating KPI Data
226
Overview
227
How to Consume Federated KPI Data from Configuration Manager
228
Troubleshooting and Limitations
231
Chapter 6: HP Configuration Manager - Federating Policy Data
232
Overview
233
How to Consume Federated Policy Data from Configuration Manager
234
Troubleshooting and Limitations
239
Chapter 7: HP Discovery and Dependency Mapping Inventory Integration
240
Overview
241
Supported Versions
241
DDMI Adapter
241
How to Populate the CMDB with Data from DDMI
243
How to Federate Data with DDMI
245
How to Customize the Integration Data Model in UCMDB
245
Predefined Queries for Population Jobs
247
DDMI Adapter Configuration Files
247
Troubleshooting and Limitations
248
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 9 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 8: HP IT Executive Scorecard
249
Overview
250
Supported Versions
250
How to Push Data from UCMDB to Executive Scorecard
250
Executive Scorecard Adapter
253
Chapter 9: HP Network Automation (NA) Integration
255
Overview
256
Supported Versions
256
Topology
256
How to Pull Data Topology from an HP NA Server using a Java Client
257
Pull Topology from HP NA Adapter
260
Limitations
262
Chapter 10: HP Network Node Manager (NNMi) Integration
Overview
Use Cases
263
264
264
Supported Versions
264
NNMi - UCMDB Integration Architecture
265
Topology
266
How to Run NNMi–UCMDB Integration
266
How to Manually Add the IpAddress CI of the NNMi Server
269
How to Set Up HP NNMi–HP UCMDB Integration
270
NNMi Integration Job
271
How to Customize Integration
276
Troubleshooting and Limitations
280
Chapter 11: HP OneView Pull Integration
Overview
Discovery Mechanism
HP Universal CMDB (Content Pack 17.00 (CP17))
282
282
282
Page 10 of 366
Universal Discovery Content Guide - HP Integrations
Supported Versions
282
Create an Integration Point between HP OneView and UCMDB
283
Data Mappings
286
Input CITs
286
Used Scripts
286
Discovered CITs
287
Global Configuration File
287
Topology Map
287
Troubleshooting and Limitations
288
Chapter 12: HP Service Anywhere Push Integration
Overview
How Data is Synchronized Between UCMDB and Service Anywhere
289
290
290
Supported Versions
291
How to Integrate UCMDB and Service Anywhere
291
Set up UCMDB
291
Push CI Data from UCMDB to Service Anywhere
295
Schedule Data Push Jobs
298
Tailor the Integration
300
Integration Architecture
300
Data Flow Architecture
300
Integration TQL Queries
301
Service Anywhere Rules and Flows
301
Data Mapping
301
Push Mapping
301
Change Adapter Settings
303
Customize an Existing Mapping
305
Add a New Mapping to the Integration
306
Troubleshooting and Limitations
Chapter 13: HP Service Manager Integration
HP Universal CMDB (Content Pack 17.00 (CP17))
309
310
Page 11 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 14: Storage Essentials (SE) Integration
311
Overview
313
Supported Versions
313
How to Perform the SE Integration
313
Storage Essentials Integration Packages
315
Adapter Parameters
316
Discovered CITs and Relationships
317
Node Details
319
SAN Topology
320
Storage Topology
320
Views
321
Storage Array Details
321
FC Switch Details
322
FC Switch Virtualization
322
Storage Pool Details
323
Host Storage Details
323
SAN External Storage
324
SAN Topology
325
Storage Topology
325
FC Port to FC Port
326
Impact Analysis Rules
326
FC Port to FC Port
326
FC Switch Devices to FC Switch
327
Host Devices to Host
327
Logical Volume to Logical Volume
328
Storage Array Devices to Storage Array
328
Reports
328
Storage Array Configuration
329
Host Configuration
329
Storage Array Dependency
329
Host Storage Dependency
330
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 12 of 366
Universal Discovery Content Guide - HP Integrations
Storage Pool Configuration
Troubleshooting and Limitations
Chapter 15: HP Storage Operations Manager (SOM) Integration
330
330
332
Overview
333
Supported Versions
333
How to Perform the SOM Integration
334
Install the Integration
334
Enable the Integration
334
Adapter Properties
337
Discovered CITs and Relationships
339
Node Details
340
SAN Topology
340
Storage Topology
341
Views
341
Storage Array Details
342
FC Switch Details
342
FC Switch Virtualization
343
Storage Pool Details
343
Host Storage Details
344
SAN External Storage
344
SAN Topology
345
Storage Topology
346
FC Port to FC Port
346
Impact Analysis Rules
347
FC Port to FC Port
347
FC Switch Devices to FC Switch
347
Host Devices to Host
348
Logical Volume to Logical Volume
348
Storage Array Devices to Storage Array
349
Reports
349
Storage Array Configuration
349
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 13 of 366
Universal Discovery Content Guide - HP Integrations
Host Configuration
350
Storage Array Dependency
350
Host Storage Dependency
351
Storage Pool Configuration
351
Known Issues
Chapter 16: HP Systems Insight Manager (HP SIM) Integration
351
353
Overview
354
Supported Versions
354
HP SIM Integration Mechanism
354
How to Discover HP SIM Data Center Infrastructure
357
SIM WebService Ports Job
360
SIM Integration by WebServices Job
361
Instance Views
363
Troubleshooting and Limitations
365
Send Documentation Feedback
366
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 14 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
Chapter 1: HP APM Push Integration
This section includes the following:
l
"Overview" below
l
"Supported Versions" on page 17
l
"How to Integrate UCMDB and HP APM" on page 17
l
"View UCMDB Data in HP APM" on page 27
l
"Customize the Integration" on page 27
l
"Developer References" on page 32
l
"Troubleshooting and Limitations" on page 41
Overview
The integration between HP APM and HP Universal CMDB (UCMDB) enables you to share information
from UCMDB with HP APM.
You can use the integration to automate the creation and update of requests in HP APM, freeing you
from repetitive and manual input of information in HP APM. This also ensures that HP APM is kept up to
date with real, accurate, discovered data in your environment.
The following table provides an overview of the HP APM integration with UCMDB:
Integration direction
From UCMDB to HP APM
Integration technology
Push adapter
Pushed data
CIs created in UCMDB are pushed to HP APM to create
requests in HP APM
HP Universal CMDB adapter
HP Universal CMDB (Content Pack 17.00 (CP17))
HP APM Push Adapter (APMPushAdapter)
Page 15 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
How Data is Synchronized Between HP APM and UCMDB
When referring to the concept of data information, it is important to distinguish between a UCMDB CI
(Configuration Item) and an HP APM Application. Both are defined in a different Data Model, and there
must be a conversion before transferring CIs in UCMDB to Applications in HP APM.
The following graphic shows the high-level components of the integration:
Note: The Push Adapter is executed in the Data Flow Probe/Integration Service process.
UCMDB stores its information using CIs. The integration chooses which data to pull from UCMDB by
defining integration TQL queries. Each TQL query defines a superset of data relevant for the integration.
The UCMDB Push Engine:
l
Retrieves the required data from UCMDB, using the given TQL query.
l
Filters the data to include only the data that has changed since the last execution of this
synchronization.
l
Splits the data into multiple chunks without breaking consistency.
l
Sends the information to the Probe/Adapter.
The Push Adapter is a generic framework for easily configuring push adapters, using only XML and
Groovy. It allows easy mapping of the data from the UCMDB data model into the HP APM data model,
and the transfer of this converted data into the HP APM database through REST APIs called from HP
APM.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 16 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
For more information about push adapter, see Developing Push Adapters in the HP Universal CMDB
Developer Reference Guide.
For details about REST APIs that this integration call from HP APM, see "REST APIs Called in the
Integration" on page 39.
For entity mappings and field mappings between HP APM and UCMDB, see "Default Entity and Field
Mappings between HP APM and UCMDB" on page 33.
Supported Versions
The HP APM adapter supports the following:
l
Universal CMDB version 10.00 and later
l
HP Project and Portfolio Management Center (PPM Center) version 9.22 (and later) where HP APM for
PPM 9.20 is installed
How to Integrate UCMDB and HP APM
To set up integration between UCMDB and HP APM, you must complete the following steps:
l
"Deploy the APM Push Adapter" below
l
"Create an Integration Point between HP APM and UCMDB" on the next page
l
"(Optional) Push CI Data from UCMDB to HP APM" on page 22
l
"Schedule Data Push Jobs" on page 26
Deploy the APM Push Adapter
To integrate HP APM with UCMDB, administrators must deploy the APM Push Adapter.
Note: If your UCMDB version is 10.10, you can skip the steps below and proceed to "Create an
Integration Point between HP APM and UCMDB" on the next page. The APM Push Adapter is deployed
on UCMDB version 10.10 by default.
To download the APM Push Adapater zip package and deploy it:
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 17 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
1. Obtain the APM Push Adapter from the HP Live Network.
a. Go to the HP Live Network page for Integrations and Other Content for Discovery and
Dependency Mapping: https://hpln.hp.com//node/32/contentfiles?dir=17109
b. If you have not logged in, the HP Passport sign-in page opens.
Provide your User ID and Password, and click Sign-in.
c. Click APM integration package to download the APMPushAdapter.zip package.
2. Start the UCMDB server.
3. Open a browser and log on to UCMDB as an administrator.
Example of the UCMDB login page URL:
http://<UCMDBServerName.Domain>:8080/ucmdb-ui/login_page.jsp
4. From the left navigation bar, click the Administration tab.
5. Click Package Manager.
6. Click Deploy packages to server (from local disk)
.
The Deploy Packages to Server dialog opens.
7. Click Add
.
8. Browse to the folder where APMPushAdapter.zip is located. Select the zip file, and click Open.
9. Click Deploy.
10. Click OK when the following confirmation message displays: Resources were deployed
successfully.
Create an Integration Point between HP APM and UCMDB
1. Log on to UCMDB as an administrator.
2. Navigate to Data Flow Management > Integration Studio.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 18 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
UCMDB displays a list of existing integration points.
3. Click the New Integration Point
button.
The New Integration Point dialog box opens.
4. Complete the Integration Properties and Adapter Properties fields as shown in the following table:
Field
(*Required)
Description
Integration Properties section
*Integration Name
Type the name (unique key) of the integration point.
Integration Description
Type a description of the current integration point.
*Adapter
Click the Select Adapter
button and select HP Software Products
> APM > APM Push Adapter from the Select Adapter dialog.
*Is Integration
Select this option to indicate the integration point is active.
Activated?
Adapter Properties section
*Protocol Type
Select http or https from the drop-down list
*Hostname/IP
Type the hostname or IP Address of the PPM Server. For example,
16.166.16.16 or hostname.
*Port
Type the communication port of the PPM Server. The default value is
80. Example: 30000
*Path
Type the path of the PPM Server. The default value is itg.
*Credentials ID
Click the Select Credential Id
button, then select Generic Protocal
or DefaultDomain > Generic Protocal in the Protocal pane, and from
the Credentials list, select a credential or create a new credential that
is to be used by UCMDB to access HP APM.
To create a credential for this integration point,
a. Click the Select Credential Id
HP Universal CMDB (Content Pack 17.00 (CP17))
button. The Choose Credentials
Page 19 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
Field
(*Required)
Description
dialog opens.
b. Click the Create new connection details for selected protocol
type
button. The Generic Protocol Parameters dialog opens.
c. Provide values for the following fields and click OK:
l
Network Scope: Use the default value ALL.
l
User Label: Type a label for the credential.
l
User Name: Provide the user name for the HP APM account
that is to be used by UCMDB to access HP APM.
Password: Click
l
and provide the password for the HP
APM account that is to be used by UCMDB to access HP APM.
d. Click OK twice.
Tip: Users of any of the following security groups can be used as
Credentials ID:
*Data Flow Probe
o
APM User
o
APM Administrator
o
APM Analyst
The name of the Data Flow Probe/Integration service used to execute
the synchronization from.
Select IntegrationService for this integration.
Note: If the IntegrationService option does not exist, consult
with your UCMDB administrator for the best selection for your
requirements.
Additional Probes
Not required for this integration point.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 20 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
Below is an example of the completed dialog:
5. Click Test Connection to make sure there is a valid connection.
6. Click OK.
The integration point is created and its details are displayed. (It is not saved to the server until you
click on the OK button)
UCMDB creates a default data push job when creating the integration point. The default data push
job includes everything, it runs immediately and performs a Full Synchronization.
Note: The first Full Synchronization may take a while to complete.
If needed you may create or edit the existing job. To create or edit and run a customized data push
job, see "(Optional) Push CI Data from UCMDB to HP APM" on the next page.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 21 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
For instructions about scheduling the data push job, see "Schedule Data Push Jobs" on page 26.
(Optional) Push CI Data from UCMDB to HP APM
Data push jobs copy or update CI or CI relationship records from the local UCMDB system to your HP APM
system.
To run a customized data push job, complete the following steps:
1. Log on to UCMDB as an administrator.
2. Navigate to Data Flow Management > Integration Studio.
UCMDB displays a list of existing integration points.
3. Select the integration point you created for HP APM.
4. Select the default data push job APM Push.
Or, if the default data push job does not satisfy your needs, you may add a new data push job as
follows:
a. Click the New Integration Job
button in the right panel.
b. In the Name field, type a unique name for the job.
c. Click the Add Query
button to add existing TQL queries to the job.
UCMDB creates a default data push job when creating the integration point for HP APM. The
following table lists the Topology Query Language (TQL) queries in the default data push job. If
required, you may create, update, or remove TQL queries for the push job. You may also need
to update the mapping.
Note: To access these OOTB TQL queries for push, navigate to Modelling > Modeling
Studio > Resources, select Queries from the drop-down list for the Resource Type field
and then navigate to Root > Integration > APM Push.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 22 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
TQL Query
Description
APM Location Push
Pushes Location CIs.
Mapping XML: pushMappingAPMLocation.xml
APM Process Push
Pushes BusinessProcess CIs.
Mapping XML: pushMappingAPMProcess.xml
APM Process
Relation Clear Push
Clears old relations between processes in HP APM.
This TQL query synchronization must have been run BEFORE the
'APM Process Relation Push' TQL query synchronization.
Mapping XML: pushMappingAPMProcessRClear.xml
APM Process
Relation Push
Pushes relations between Processes (pushed by APM Process Push)
to other business elements or to processes.
BusinessProcess CIs must have been pushed before this TQL query
synchronization in the ‘APM Process Push’ TQL query
synchronization.
Mapping XML: pushMappingAPMProcessR.xml
APM Server Push
Pushes Node CIs (Computers, Network Devices, etc.).
Mapping XML: pushMappingAPMServer.xml
APM Server Relation
Clear Push
Clears old relations between Servers in HP APM.
This TQL query synchronization must have been run BEFORE the
'APM Server Relation Push' TQL query synchronization.
Mapping XML: pushMappingAPMServerRClear.xml
APM Server Relation
Push
Pushes relations between Servers (pushed by APM Server Push) to
other servers.
Node CIs must have been pushed before this TQL query
synchronization in the ‘APM Server Push’ TQL query synchronization.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 23 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
TQL Query
Description
Mapping XML: pushMappingAPMServerR.xml
APM Application
Push
Pushes BusinessApplication CIs.
Location, BusinessProcess, and/or Node CIs must have been pushed
before this TQL query synchronization.
Mapping XML: pushMappingAPMApplication.xml
APM Application
Relation Clear Push
Clears old relations (except for the downstream relations) between
Applications in HP APM.
This TQL query synchronization must have been run BEFORE the
'APM Application Relation Push' TQL query synchronization.
Mapping XML: pushMappingAPMApplicationRClear.xml
APM Application
Relation Push
Pushes relations (except for the downstream relations) between
Applications (pushed by APM Application Push) to other business
elements or to nodes.
BusinessApplication CIs must have been pushed before this TQL
query synchronization in the ‘APM Application Push’ TQL query
synchronization.
Mapping XML: pushMappingAPMApplicationR.xml
APM Application
Relation Clear Down
Push
Clears old downstream relations between Applications in HP APM.
This TQL query synchronization must have been run BEFORE the
'APM Application Relation Down Push' TQL query synchronization.
Mapping XML: pushMappingAPMApplicationDownRClear.xml
APM Application
Relation Down Push
Pushes downstream relations between Applications (pushed by APM
Application Push) to other business elements or to nodes.
BusinessApplication CIs must have been pushed before this TQL
query synchronization in the ‘APM Application Push’ TQL query
synchronization.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 24 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
TQL Query
Description
Mapping XML: pushMappingAPMApplicationDownR.xml
d. Select the Allow Deletion option for each query.
This allows deletion of synchronized data in HP APM when data in UCMDB are deleted.
Otherwise requests created in HP APM as a result of synchronization remain even when their
original data in UCMDB are deleted.
Note: For scheduling configuration, see "Schedule Data Push Jobs" on the next page.
e. Click OK.
f. Save the integration point.
5. Run the job manually to see if the integration job works properly:
a. To push all the relevant data for the job, click the All Data Synchronization
Synchronization
button (or Full
).
b. To push only the changes in the data since the job last executed, click the Changes
Synchronization
button (or Delta Synchronization
).
6. The job is in Running status. Wait for the job to complete; click the Refresh
button multiple
times as needed until the job is completed.
You can also look at the Query tab as that gives a progress bar against the query it is running.
7. When the job is completed, the job status becomes one of the following depending on the results:
o
Succeeded
o
Passed with failures
o
Failed
8. Click the Statistics tab to view the results; if any errors occur, click the Query Status tab and Job
Errors tab for more information. For more information about errors, see "Troubleshooting and
Limitations" on page 41.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 25 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
Schedule Data Push Jobs
UCMDB allows you to schedule job executions directly from a data push job.
1. Log on to UCMDB as an administrator.
2. Navigate to Data Flow Management > Integration Studio.
UCMDB displays a list of existing integration points.
3. Select the integration point you created for the APM - UCMDB integration.
4. Select the APM Push job.
5. Click the Edit Integration Job
button.
The Edit Integration Job dialog opens.
Note: UCMDB allows you to define two different schedules for two types of data push:
Changes Synchronization (or Delta Synchronization) and All Data Synchronization (or Full
Synchronization). It is recommended to use the Changes Sync schedule to only synchronize
changes and avoid synchronizing the entire set of data each time.
6. Define a schedule for Changes Synchronization or Delta Synchronization.
a. Click on the Changes Synchronization tab (or Delta Synchronization).
b. Select the Scheduler enabled option.
c. Select the scheduling options you want to use.
7. Click the All Data Synchronization tab (or Full Synchronization) and select the scheduling options
you want to use.
8. Click OK.
9. Save the integration point.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 26 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
View UCMDB Data in HP APM
After a push job is successfully completed, you can search for and verify that the pushed CI/relationship
data is in HP APM.
To view UCMDB data in HP APM,
1. Log on to PPM Center.
2. On the Open menu, click Application Portfolio > Search Entities.
The Search Entities page opens.
3. In the Entities section, click one of the following entities:
o
Application
o
Location
o
Process
o
Server
The Search: APM - <Entity> page opens.
In this example, click Application and the Search: APM - Application page opens.
4. Click Search.
The Search Results page displays request search results.
5. Click any Application No to view an APM - <Entity> request.
Customize the Integration
This section includes:
l
"Overview" on the next page
l
"Customize an Existing Mapping" on the next page
l
"Add a New Mapping to the Integration" on page 29
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 27 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
Overview
This section contains details about the architecture of the integration.
Data Flow Architecture
1. The Push Engine executes the TQL query.
2. For a differential flow, the data is compared to the last synchronized data, and only the changes
are forwarded.
3. Data is converted into Composite CIs (instances of data according to the TQL Root elements).
4. Data is then pushed to the Push Adapter.
5. The Push Adapter loads the correct mapping for the specific TQL query.
6. All dynamic_mappings are executed and saved to maps, to allow usage in the next mapping stage.
For more information, see Developing Push Adapters in the HP Universal CMDB Developer Reference
Guide.
7. Data is sent to HP APM database via REST APIs from HP APM, where REST APIs converts data to HP
APM compatible data.
Integration TQL Queries
A TQL query used for the integration must contain a root query node.
Any attribute used in the mapping flow of the Push Adapter must be marked in the selected layout of
the query node. Each TQL query may only have one mapping.
For more information, see Data Flow Management > Integration Studio > Integration Jobs Pane.
Customize an Existing Mapping
This example shows you how to add the NAME attribute to the integration including the TQL query and
Push Adapter Mapping. It allows the integration to push the NAME attribute to Location in HP APM.
After completing the following steps, you may run the job with the customized mapping:
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 28 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
1. Add the NAME attribute to the APM Location Push TQL query layout.
In this step we add the NAME attribute of the Location to the integration TQL query (APM Location
Push TQL) so that we can use the attribute and value in the mapping.
a. Navigate to Modeling > Modeling Studio > Resources and select the Queries Resource Type.
b. Navigate to Query: Root > Integration > APM Push > APM Location Push.
c. Select Root, right-click and select Query Node Properties.
d. Go to the Element Layout tab.
e. Move the Name to the Specific Attributes box.
f. Click OK.
g. Save the Query.
2. Add the NAME Mapping to the pushMappingAPMLocation.xml push adapter mapping.
In this step we take the value from the TQL result and remodel it to the HP APM Data Model.
a. Navigate to Data Flow Management > Adapter Management > Packages > APMPushAdapter
> Configuration Files > pushMapingAPMLocation.xml.
b. Navigate to the <target_ci_type name="fields"> XML tag.
c. Below the tag, add the following XML tag to hold the value of the Description:
<target_mapping name="REQ.DESCRIPTION" datatype="STRING"
value="APMPushFunctions.subString(Root['name'],200)"/>
where, "REQ.DESCRIPTION" is the request Name field token of Location.
d. Click OK.
Add a New Mapping to the Integration
This example shows how to add a new TQL query and push-mapping to the integration. It also shows
how to push Locations from UCMDB to HP APM. It consists of the following steps:
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 29 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
Step 1: Create a TQL Query
1. Navigate to Modeling > Modeling Studio > New > Query.
2. From the CI Types tab, add a Location to the query.
3. Right-click the Location Query Node and select Query Node Properties.
4. Rename the Element Name to Root.
5. Navigate to the Element Layout tab.
6. Select Select attributes for layout.
7. In the Attributes condition drop down, select Specific Attributes, and add the Name attribute
8. Click OK.
9. Save the query to Root > Integration > APM Push > APM Location Push.
Step 2: Create a Push-Mapping
1. Navigate to Data Flow Management > Adapter Management > APMPushAdapter.
2. Click the Create new resource
button and select New Configuration File.
3. Type the following Name: APMPushAdapter/mappings/pushMappingAPMLocation.xml.
4. Select the APMPushAdapter package.
5. Click OK.
6. Copy the following into the newly created XML file:
<integration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<info>
<source name="UCMDB" versions="10.0" vendor="HP"/>
<target name="APM" versions="2.0" vendor="HP"/>
</info>
<import>
<scriptFile path="mappings.scripts.APMPushFunctions"/>
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 30 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
</import>
<targetcis>
<source_instance_type query-name="APM Location Push" root-elementname="Root" >
<target_ci_type name="request">
<target_mapping name="uuid" datatype="STRING" value="Root['global_
id']"/>
<target_mapping name="requestType" datatype="STRING" value="'APM Location'"/>
<target_mapping name="description" datatype="STRING" value="Root
['name']"/>
<target_ci_type name="fields">
<target_mapping name="REQ.DESCRIPTION" datatype="STRING"
value="APMPushFunctions.subString(Root['name'],200)"/>
</target_ci_type>
</target_ci_type>
</source_instance_type>
</targetcis
</integration>
In the following line:
<target_mapping name="requestType" datatype="STRING" value="'APM - Location'"/>
The value is the request type name in HP APM. In this example, it is APM - Location.
7. Click OK.
Step 3: Create a Job with the New TQL Query
1. Navigate to Data Flow Management > Integration Studio.
2. Create an Integration Point with HP APM.
3. In the Integration Jobs tab, click the New Integration Job
button .
4. Insert a job name in the Name field.
5. Click the
button, and choose the APM Location Push query.
6. Click OK.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 31 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
Step 4: Run the Job
1. Click on the job created in "Step 3: Create a Job with the New TQL Query" on the previous page.
2. Click the All Data Synchronization
button (or Full Synchronization
3. Wait for the job to finish. You should click the Refresh
).
button to see progress.
4. Make sure that the status is Succeeded.
Step 6: View the Results
1. Log on to .
2. On the Open menu,
o
Click Application Portfolio > Search Entities, then in the Entities section, click Location. Or,
o
Click Search > Requests, then from the Request Type drop-down list, select APM - Location.
3. Click Search.
The Search Results page displays request search results.
Developer References
This section includes the following:
l
"Adapter" below
l
"Default Entity and Field Mappings between HP APM and UCMDB" on the next page
l
"REST APIs Called in the Integration" on page 39
Adapter
This integration job uses the adapter called APMAdapter.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 32 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
Input CI Type
destination_config
Triggered CI Data
Name
Value
adapterId
${ADAPTER.adapter_id}
attributeValues
${SOURCE.attribute_values}
credentialsId
${SOURCE.credentials_id}
destinationId
${SOURCE.destination_id}
Adapter Parameters
Name
Value
credentialsId
domain
itg
host
port
80
probeName
protocalType
http
Default Entity and Field Mappings between HP APM and
UCMDB
The following sections describe out of the box mappings that are available with the APM Push Adapter
for integration with HP APM and UCMDB.
The following table provides an overview of type mappings between HP APM entities and UCMDB CI
Types:
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 33 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
HP APM Entity
PPM Center
Request Type
UCMDB CI Type
Remarks
Application
APM -
BusinessApplication
For detailed mappings, see "Default
Application
Field Mappings between HP APM
Application and UCMDB
BusinessApplication" below.
Process
APM - Process
BusinessProcess
For detailed mappings, see "Default
Field Mappings between HP APM
Process and UCMDB
BusinessProcess" on page 36.
Location
APM - Location
Location
For detailed field mappings, see
"Default Field Mappings between HP
APM Location and UCMDB Location"
on page 37.
Server
APM - Server
Node
For detailed field mappings, see
"Default Field Mappings between HP
APM Server and UCMDB Node" on
page 38.
Default Field Mappings between HP APM Application and UCMDB
BusinessApplication
The following table describes the default field mappings that can be modified for the integration
between the HP APM entity of Application and the UCMDB CI Type of BusinessApplication.
HP APM Field Name and Field Type
UCMDB CI Attribute and Field Type
Name
Name
KNTA_PROJECT_NAME
name
Text Field - 300
string
Updated By a
(N/A)
Create On b
(N/A)
CREATION_DATE
Date
Purpose
HP Universal CMDB (Content Pack 17.00 (CP17))
Description
Page 34 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
HP APM Field Name and Field Type
UCMDB CI Attribute and Field Type
APM_APP_PURPOSE
description
Text Field - 4000
string
Business Criticality c
BusinessCriticality
APM_RATING_BUSINESS_CRIT
business_criticality
Drop Down List
integer
Created Bya
(N/A)
CREATED_BY
Auto Complete List
Supported Processes
Name (of CI Type BusinessProcess)
APM_SUPPORTED_PROCESSES
name (of CI Type BusinessProcess)
Auto Complete List
string
Downstream Applications
Name (of downstream CI Type
APM_DOWNSTREAM_APPS
BusinessApplication)
Auto Complete List
name (of downstream CI Type
BusinessApplication)
string
Upstream Applications
Name (of upstream CI Type BusinessApplication)
APM_UPSTREAM_APPS
name (of upstream CI Type BusinessApplication)
Auto Complete List
string
Service Level Agreement
Name (of CI Type ServiceLevelAgreement)
APM_APP_SLA
name (of CI Type ServiceLevelAgreement)
Text Field - 200
string
Servers
Name (of CI Type Node)
APM_SERVER_LIST
name (of CI Type Node)
Auto Complete List
string
Database
Name (of CI Type Database)
APM_DATABASE_LIST
name (of CI Type Database)
Text Field - 200
string
a. The HP APM account you provided when creating the integration point (see "Create an Integration Point between
HP APM and UCMDB" on page 18).
b. Time when the request is created for the first time in HP APM.
c. The following mapping rule is used for this mapping:
<target_mapping name="REQD.APM_RATING_BUSINESS_CRIT" datatype="STRING"
value="APMPushFunctions.getPropertyValue('bc', Root['business_
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 35 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
HP APM Field Name and Field Type
UCMDB CI Attribute and Field Type
criticality'].toString() , '')"/>
where the definition of ‘bc’ token is defined as follows in the server.properties field:
bc.0=0
bc.1=1
bc.2=2
bc.3=3
bc.4=4
bc.5=5
-
Least critical
Slightly critical
Less than average
More than average
Critical
Highly critical
When synchronizing the Business Criticality field from UCMDB to HP APM, if the value is ‘1’ in UCMDB, then the
field value will be set to ‘1 - Slightly critical’ in APM.
Default Field Mappings between HP APM Process and UCMDB
BusinessProcess
The following table describes the default field mappings that can be modified for the integration
between the HP APM entity of Process and the UCMDB CI Type of BusinessProcess.
HP APM Field Name,
Database ID,
and Field Type
UCMDB CI Attribute,
Database ID,
and Field Type
Process Name
Name
DESCRIPTION
name
Text Field - 200
string
Parent Process
Name of parent BusinessProcess
APM_PARENT
name of parent BusinessProcess
Auto Complete List
string
Description
Description
APM_DESCRIPTION
description
Text Area - 4000
string
Created By a
(N/A)
CREATED_BY
Auto Complete List
Created On b
(N/A)
CREATION_DATE
Date
a. The HP APM account you provided when creating the integration point (see "Create an Integration Point between
HP APM and UCMDB" on page 18)
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 36 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
HP APM Field Name,
Database ID,
and Field Type
UCMDB CI Attribute,
Database ID,
and Field Type
b. Time when the request is created for the first time in HP APM.
Default Field Mappings between HP APM Location and UCMDB
Location
The following table describes the default field mappings that can be modified for the integration
between the HP APM entity of Location and the UCMDB CI Type of Location.
HP APM Field Name,
Database ID,
and Field Type
UCMDB CI Attribute,
Database ID,
and Field Type
Location Name
Name
DESCRIPTION
name
Text Field - 200
string
Description
Description
APM_DESCRIPTION
description
Text Field - 4000
string
Address
StreetAddress+ExtendedStreetAddress
APM_LOC_ADDRESS
street_address+extended_street_address
Text Field - 200
string+string
Postal Code
PostalCode
APM_LOC_ZIPCODE
postal_code
Text Field - 20
string
Country
CountryOrArea
APM_LOC_COUNTRY
country_or_area
Text Field - 200
string
Region
Region
APM_LOC_REGION
region
DDL
string
Longitude
Longitude
APM_LONGITUDE
longitude
Text Field - 40
string
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 37 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
HP APM Field Name,
Database ID,
and Field Type
UCMDB CI Attribute,
Database ID,
and Field Type
Latitude
Latitude
APM_LATITUDE
latitude
Text Field - 40
string
City
Citya
APM_LATITUDE
Text Field - 200
city
string
State/Province
Statea
APM_STATE
state
string
Text Field - 200
a. The CI attribute is removed from UCMDB version 10.x, but exists in earlier versions of UCMDB. For UCMDB
instances that upgraded from an earlier version to 10.x, this CI attribute exists but is read-only. If the CI attribute
has a value, the value can be synchronized to HP APM, otherwise the HP APM field remains empty after you run the
synchronization push job in UCMDB.
Default Field Mappings between HP APM Server and UCMDB Node
The following table describes the default field mappings that can be modified for the integration
between the HP APM entity of Server and the UCMDB CI Type of Node.
HP APM Field Name,
Token,
and Component Type
UCMDB CI Attribute Display Name,
Name,
and Type
Server Name
Name
DESCRIPTION
name
Text Field - 200
string
Description
Description
APM_DESCRIPTION
description
Text Area - 4000
string (value size: 1000)
IP Address
IP Address (of IpAddress)
APM_IP_ADDRESS
ip_address (of IpAddress)
Text Field, Max Length: 15
string
OS
OsDescription
APM_OS
os_description
Drop-down List
string
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 38 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
HP APM Field Name,
Token,
and Component Type
UCMDB CI Attribute Display Name,
Name,
and Type
Running Software
ProductName:Name (of RunningSoftware)
APM_RUNNING_SOFTWARE
product_name:name (of RunningSoftware)
Text Area - 4000
product_name_enum:string
Location
Name (of Location)
APM_LOCATION
name (of Location)
Auto Complete List
string
REST APIs Called in the Integration
The following HP Demand Management REST APIs are called in this integration to convert data from
UCMDB into HP APM compatible data:
l
Get a request
For more information, see Get Details of a Request section of the RESTful Web Services Guide for
9.20.
l
Create a request
For more information, see Create/Update a Request section of the RESTful Web Services Guide for
9.20.
l
Update a request
For more information, see Create/Update a Request section of the RESTful Web Services Guide for
9.20.
l
Delete a request
Added in version 9.22. For more information, see "Delete a Request" below.
Delete a Request
Request: http://<PPM_Server_IP>:<port>/itg/rest/dm/requests/{reqId}
HTTP Method: DELETE
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 39 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
Description: Delete a request with a specific ID. To perform this operation, you must be in one or more
of the authorized security groups for the create/update action.
Request path variables:
Attribute
Description
Required?
reqId
Request ID. Indicates which request will be deleted.
Yes
Response entity body:
l
on success: When the operation is successfully executed, no message is returned. However, the
REST API automatically calls the GET operation and returns the following message in Response
Header (with empty message body):
Status Code: 204 No Content
Cache-Control: no-cache
Date: Mon, 26 Aug 2013 09:20:29 GMT
Expires: -1
Pragma: no-cache
l
on failure: The following message codes are returned if the operation fails:
Message
Code
Message
Cause
Possible Corrective Action
PPMC_
Not Found
The quest is not found.
The request ID is not passed or
WSE108
the request of this ID doesn’t
exist.
PPMC_
Internal Server
There was an error when
WSE001
Error
you tried to delete a
N/A
request.
PPMC_
Internal Server
There was an error when
WSE116
Error
you tried to delete a
N/A
request.
Limitation:
This operation supports field security check, but it ignores user interface (UI) rules or status
dependency. Such constraints have to be validated and enforced on the client side before this operation
is invoked.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 40 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
Troubleshooting and Limitations
This section includes the following:
l
"Limitations" below
l
"Troubleshooting Problems" on the next page
l
"Logs" on page 43
Limitations
l
The Data Flow Probe or Integration Service must be installed on a Windows OS.
l
For requests created in HP APM from CIs pushed from UCMDB, any changes made in HP APM are
overwritten when you run the data push job in UCMDB.
l
The APM Application request form holds a single value for Location, therefore it is designed to push
only one value for Location of the Application from the UCMDB BusinessApplication.
In the definition of Location of the Application (see the pushMappingAPMApplicationR.xml file),
the Location of the Server is used for the Location of the Application is used. For an Application that
contains multiple servers, select one of the servers and then you can get its Location.
l
For value mappings between UCMDB and HP APM, certain mapping rules are followed.
For example, when synchronizing the Business Criticality field of Application, the following mapping
rule is used for the mapping:
<target_mapping name="REQD.APM_RATING_BUSINESS_CRIT" datatype="STRING"
value="APMPushFunctions.getPropertyValue('bc', Root['business_
criticality'].toString() , '')"/>
where the definition of ‘bc’ token is defined as follows in the
<APMPushAdapter.zip>/mappings/scripts/server.properties file:
bc.0=0
bc.1=1
bc.2=2
bc.3=3
-
Least critical
Slightly critical
Less than average
More than average
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 41 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
bc.4=4 - Critical
bc.5=5 - Highly critical
When synchronizing the Business Criticality field from UCMDB to HP APM, if the value is ‘1’ in
UCMDB, then the field value will be set to ‘1 - Slightly critical’ in APM.
If you need to use this value mapping for other fields from UCMDB to APM, make sure you customize
the mapping by following the example above.
l
This integration does not support synchronizing values in languages that are not supported by
UCMDB. For example, Simplified Chinese.
l
The ";" character is not supported. If a UCMDB CI name contains a ";" character, it would be treated
as a separator and two entries would show up in HP APM after synchronization.
Troubleshooting Problems
l
Problem: Some UCMDB CIs include characters that are not supported in APM Entities. For example,
semicolon (;).
Solution: The suggested solution is to modify the content synchronized from UCMDB to APM. You
can use the Replace function to replace the unsupported characters for this field mapping in the
XML mapping file. However, note that this may cause inconsistent content between UCMDB and APM.
An example, in the pushMappingAPMApplication.xml file, the semicolon character (;) is replaced
with a space:
<target_mapping name="REQ.KNTA_PROJECT_NAME" datatype="STRING"
value="APMPushFunctions.stringReplace(Root['name'], ';', ' ')"/>
l
Problem: For some fields, the field value lengths between HP APM and UCMDB are different,
therefore you may need to customize the field mapping. You can follow the example below:
Example
Use a substring as illustrated below to limit the field length to 200 characters:
<target_mapping name="REQ.DESCRIPTION" datatype="STRING"
value="APMPushFunctions.subString(APMPushFunctions.stringReplace(Root
['name'],';',' '),200)"/>
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 42 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
Logs
The push adapter framework uses a different logging system for the normal fcmdb.adapters.*.log files.
To change the level of the log files to debug, edit the following file:
l
On the Data Flow Probe machine:
..\DataFlowProbe\conf\log\fcmdb.push.properties
l
If using the integration service, on the UCMDB server:
..\UCMDB Server\Integrations\conf\log\fcmdb.push.properties
Change the log level to DEBUG:
loglevel=DEBUG
The integration generates fcmdb.push.* logs in the following folder:
l
On the Data Flow Probe machine:
..\DataFlowProbe\runtime\log\
l
If using the integration service, on the UCMDB server:
..\UCMDB Server\Integrations\runtime\log\
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 43 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 1: HP APM Push Integration
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 44 of 366
Chapter 2: HP Asset Manager Population
Integration
This chapter includes:
Overview
47
Supported Versions
47
How to Integrate Asset Manager with UCMDB
47
Verify UCMDB to AM Configuration
52
What CI data is populated from AM to UCMDB?
53
Population TQLs
53
Criteria for AM records to be propagated
54
What is created in UCMDB during population?
58
Reconciliation
58
What happens when changes occur in AM during data population?
59
Supported CI Types
59
Supported CI attributes and the mapping with the AM fields
60
CI Type: Asset
60
CI Type: IpAddress
60
CI Type: Node
61
CI Type: CPU
62
CI Type: DiskDevice
62
CI Type: FileSystem
63
CI Type: InstalledSoftware
63
CI Type: Interface
63
CI Type: LogicalVolume
64
CI Type: Printer
64
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 45 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 2: HP Asset Manager Population Integration
CI Type: Location
64
CI Type: BusinessElement
64
The configuration files used by the integration
66
Where are the configuration files located
66
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 46 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 2: HP Asset Manager Population Integration
Overview
HP Asset Manager is an asset lifecycle management solution with modular components allowing an IT
organization to measure and communicate the value it provides to the business it supports.
UCMDB-Asset Manager integration is implemented by the Asset Manager adapter (AMAdapter) pulling
CIs and relationships from Asset Manager to UCMDB.
Note: In UCMDB 10.20 CP 15 and greater versions, a new Asset Manager adapter named Generic
Adapter is introduced for exchanging data between Asset Manager and UCMDB. It bundles 3 core
features of the AM and UCMDB integration in a single adapter: population, federation, and push.
We strongly recommend that you use the Generic Adapter instead of the combination of the two
conventional adapters (population and push). For more information about how to use the Generic
Adapter, see "HP Asset Manager Integration with the AM Generic Adapter" on page 122.
Supported Versions
The Asset Manager adapter supports Asset Manager Versions 9.30 and later.
How to Integrate Asset Manager with UCMDB
This task consists of the following steps:
Step 1: Get the adapter content package
1. Log on to UCMDB.
2. Browse to Data Flow Management > Adapter Management.
3. Expand AMAdapter from the resources list.
4. Expand External resources and select AMadapter/Content.zip.
5. Export to the local server and extract all files from Content.zip. The AMdatakit and AMDBUpdate
folders are displayed. AMdatakit is used to sync dtLastModif among amAsset, amPortfolio, and
amComputer tables.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 47 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 2: HP Asset Manager Population Integration
Step 2: Activate workflows in AM
1. Log on to Asset Manager Client.
2. On the Tools menu, point to Workflow, click Workflow schemes.
3. Locate the Update dtRecCreation (SQL name: sysCoreUpCrTime) workflow and the Update last
modify time (SQL name: sysCoreUpMdifyTime) workflow.
4. On the General tab, empty the End field of the Validity pane.
5. Save the changes.
Step 3: Create SQL views in the AM database
Caution: This batch file can only be used on Windows computers, not UNIX computers.
The batch file should be run from a computer where the client layers of the DBMS (for example,
Oracle Database 10g Client R2) used for the AM database are installed.
Running this batch file alters the AM database structure.
Administrative privileges are required at the DBMS level to create the SQL views.
1. Set the ORACLE_HOME environment variable.
2. Run the create view script.
a. Click start > Run.
b. Enter cmd.
c. Enter sqlplus <schema name>/<schema password>@<SID_Hostname of oracle server>.
d. Enter GRANT create ANY VIEW to <Username>.
e. Enter GRANT SELECT ANY TABLE to <Username>.
f. Enter GRANT create MATERIALIZED VIEW to <Username>.
g. Enter exit to exit Oracle.
3. Browse to the AMDBupdate folder.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 48 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 2: HP Asset Manager Population Integration
4. If using an Oracle server, run the command CreateViews.bat Oracle <Oracle SID> <Username>
<Password>; for example, CreateViews.bat Oracle SSG_labm3amdb35 SACM4 topaz.
If using an SQL server, run the command CreateViews.bat [MSSQL2005|MSSQL2008] <Server>
<Database> <Username><Password>.
5. Confirm all views created in the AM database.
Step 4: Make some CI attributes visible
1. Open a browser and log on to the UCMDB Server as an administrator.
2. From the left navigation bar, select Modeling.
3. Select CI Type Manager and select the CI Type that contains the CI attribute from the navigation
tree.
4. On the Attributes tab, double click the attribute you want to modify.
By default, the following CI attributes are not visible:
CI Type
Attribute
IpAddress
IP Address
IP is DHCP
CPU
CPU Speed
5. Select the Advanced tab, and select Visible.
Step 5: Create an integration point
1. Log on to UCMDB.
2. Browse to Data Flow Management > Integration Studio.
3. Click the New Integration Point
button.
4. In the New Integration Point dialog box, fill in the following Integration Properties.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 49 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 2: HP Asset Manager Population Integration
Name
Recommended Value
Description
Integration
Name
AM population
Name given to the integration
Adapter
AM Population and Federation
Adapter to be used for the
Adapter 9.30 and later versions
integration point.
selected
Select checkbox to create an
Is Integration
Activated
point.
active integration point.
5. In the Adapter Properties, fill in the relevant details.
Name
Recommended
Value
Description
Hostname/IP <user defined> Enter the hostname or IP address of the database server. For
SQL Server with instance name, enter <hostname>\<instance
name>
Port
<user defined> Enter the database port default port for Oracle 1521 and SQL
1433.
Credentials
ID
<user defined> Click the Add new connection details for selected protocol
type
button.
Enter the following information:
o
In Database Type, select the database type of your Asset
Manager schema:
o
l
Microsoft SQL Server
l
Oracle
l
DB2
In Port Number, type the communication port of the Asset
Manager Database.
o
In Connection Timeout[msec], enter the timeout value set
by the schema.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 50 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 2: HP Asset Manager Population Integration
Name
Recommended
Value
Description
o
In User Name, enter the user of the schema.
o
In Password, enter the password of the schema.
o
In Instance Name/ Database Name:
l
DB2: type the name of the Database Alias you defined in
the database connection in Database Name.
l
Oracle: type the service name in Instance Name.
l
SQL Server: type the name of the schema in Instance
Name.
DB
Name/SID
<user defined> Enter the database name. For Oracle, enter a service name
DB Type
<user defined> Select on of the following the database types:
instead of the SID.
o
Oracle
o
SQL Server
Push Back
IDs
Enabled
Version
<user defined> Version of Asset Manager to access
Data Flow
Probe
<user defined> Select the correct Probe from the drop-down list.
Identify a unique CI if the feature is disabled and the
reconciliation of CIs will not work.
6. Click Test connection and OK.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 51 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 2: HP Asset Manager Population Integration
Verify UCMDB to AM Configuration
Note: On first use, run the full population job. After any changes are made, only run the diff
population job.
In order to verify Asset Manager to UCMDB Population flow, we create an Asset in Asset Manager, and
verify it is synchronized as a configuration item in UCMDB.
1. Log on to Asset Manager.
2. Create a new virtual machine in the IT equipment module, specifying its name and IT equipment
type (in our case, Virtual Machine).
3. In the Assets view, add the serial number.
4. Log on to UCMDB.
5. Browse to Data Flow Management > Integration Studio.
6. Select the AM Population integration point.
7. In the Integration Jobs pane, select the Population tab and click the AM Population job.
8. Click the Full Synchronization - Runs the selected job, synchronizing all of the data button.
9. When the Confirm synchronizing window appears, click Yes.
10. Click the Refresh button and wait until the Succeeded message appears in the Status tab. The
updated synchronization status appears.
11. Browse to Modeling > IT Universe Manager.
12. Select the Search CIs tab and search for the name of the virtual machine specified in step 2.
13. Confirm that a corresponding CI exists in UCMDB.
Note: Note its name as it will be used in the next section.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 52 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 2: HP Asset Manager Population Integration
What CI data is populated from AM to UCMDB?
This section describes the CI data that is populated from AM to UCMDB.
Population TQLs
The types of CIs that can be propagated from AM to UCMDB are defined by the following TQLs included
in the integration package.
l
locationDataImport_930
This query is used to populate location data from AM.
l
hostImport_930
This query is used to populate computer data from AM.
l
networkImport_930
This query is used to populate network data from AM.
l
printerImport_930
This query is used to populate printer data from AM.
l
businessElementDataImport_930
This query is used to populate business service assets from AM.
l
businessElementRelationsImport_930
This query is used to build relations between business service assets.
To access these TQLs:
1. Open a browser and connect to the UCMDB Server.
2. Click the Modeling tab.
3. Select Modeling Studio.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 53 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 2: HP Asset Manager Population Integration
4. Click the Resources tab, and select Queries from the Resource Type drop-down list.
5. Expand the Root/Integration/AM Data In menu. The TQLs located under the path are used to
manage CI data synchronization from AM to UCMDB. They have the same structure but manage
different type of CI data.
Criteria for AM records to be propagated
Step 1: Node CIs
Node CIs in UCMDB correspond to records in the amComputer table in AM.
Out-of-the-box, the amComputer records need to satisfy the following conditions to be propagated to
UCMDB as Node CIs:
l
The status for the Portfolio Item linked to the amComputer record is in use or in stock
(amPortfolio:seAssignment = In use or In stock).
This can be configured by modifying a configuration file (see "condition_rules.xml" on page 69.
l
The amComputer:ComputerType field of the amComputer record must have a value that is present
in the third column of the following table.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 54 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 2: HP Asset Manager Population Integration
Relationship between TQL, CI Types, and computer types
Note: The path populates CIs of these CI Types to UCMDB under Managed
Objects/ConfigurationItem/ InfrastructureElement/Node/
This TQL
Populates CIs of these CI Types to
UCMDB
The CI Type corresponds to
these computer types in AM
(amComputer:ComputerType)
hostDataImport_930
Computer
Computer
Desktop computers
Computer servers
Laptop
Virtual Machine
Computer\Windows
Windows computer
Windows desktop computer
VMware VirtualCenter
VMware ESX Server
Computer\Unix
Unix server computer
Unix desktop computer
Solaris Zone server
Computer\Mainframe
Mainframe
Storage Array
Mainframe CPC
Note: Storage Array is not a
computer type value. By
default, AM will handle those
records where
amNature.Name is Storage
Provider as Storage Array.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 55 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 2: HP Asset Manager Population Integration
This TQL
Populates CIs of these CI Types to
UCMDB
The CI Type corresponds to
these computer types in AM
(amComputer:ComputerType)
networkDataImport_930
Net Device\Firewall
Firewall
Net Device\Router
Router
Net Device\Switch
Switch
This TQL
Populates CIs of these
CI Types to UCMDB
The CI Type corresponds to these computer
types in AM (amComputer:ComputerType)
networkDataImport_930
Net Device\ATM Switch
ATM switch
Node:
ADSL Modem
Appletalk Gateway
Bandwidth Manager
Cable modem
CSU_DSU
Ethernet
FDDI
HUB
KVM Switch
Load Balancer
Multicast Enabled
Router
NAT Router
Token Ring
Undefined Network
Component
VoIP Gateway
VoIP Switch
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 56 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 2: HP Asset Manager Population Integration
This TQL
Populates CIs of these
CI Types to UCMDB
The CI Type corresponds to these computer
types in AM (amComputer:ComputerType)
VPN Gateway
Wireless Access Point,
Frame_relay_switch
San_gateway
San_router
San_switch
Pad_handhel
printerDataImport_930
Net Device\Net Printer
Network printer
Note: In addition to the Node CIs, each of the TQLs also populates information (if exists) such as IP
addess, interface, and locations from AM to UCMDB.
l
The mapping between CI Type and computer type (value of the amComputer:ComputerType
field) is defined in the discriminator.properties file (see "discriminator.properties" on page 66).
Step 2: Business Element
In AM, only those business service asset whose status (amAsset.Status) in the list of built, catalogued,
chartered, designed and requested will be populated to UCMDB. If the status is retired, it will be
removed from UCMDB.
Relationship between AM business service asset and CI types:
Nature code
CI Type
BIZSVC
business_service
BIZAPP
business_application
INFRASVC
infrastructure_service
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 57 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 2: HP Asset Manager Population Integration
What is created in UCMDB during population?
When an amComputer record (with the associated information) is populated from AM to UCMDB:
l
A Node CI is created in UCMDB.
Its CI Type depends on the value of the amComputer:ComputerType field.
o
l
Relationship between TQL, CI Types, and computer types.
For each Networkcard record (amComputer:NetworkCards) attached to the AM Node CI, two CIs are
created in UCMDB: IP address and Interface.
The values of the following AM amNetworkCard table field are used to create the IPaddress and
Interface CIs:
o
amNetworkCard:TcpIpAddress, together with other field values, is used to create an IP Address
CI.
o
l
amNetworkCard:PhysAddress, together with other field values, is used to create an Interface CI.
If the AM amComputer data has an associated location which is comprised of several layers, then
one Location CI is created for each layer of location.
For example, in AM one computer has a location of /Ariane Building/31st Floor/030 – Office/, then
when the Node CI for the computer is populated to UCMDB, 3 location CIs are created for each layer
in the location, representing the building, floor and room respectively.
Note: The layers of location in AM should be less than the layer defined in the TQL, which by
default is 3. Otherwise, you need to add elements to the corresponding TQL to support it.
Reconciliation
For each CI Type, the data reconciliation is governed by the reconciliation rule set in UCMDB.
You can check the reconciliation rule for each CI Type on the Details tab of the CI Type. The field name is
Identification.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 58 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 2: HP Asset Manager Population Integration
What happens when changes occur in AM during data
population?
l
If the value of the amPortfolio:seAssignment field has been changed to a value not present in
condition.rules.xml (see "condition_rules.xml" on page 69), the corresponding CI is deleted from
UCMDB with the associated IPAddress CIs (if exists).
l
However, if the IT equipment record is deleted from AM, the previously populated CI remains in
UCMDB.
Supported CI Types
To find out the CI Types supported by the AM adapter out-of-the-box:
1. Start UCMDB Server.
2. Open a browser and connect to UCMDB Server as administrator.
3. From the left navigation bar, click the Data Flow Management tab.
4. Click Integration Studio.
5. Select the integration point created for AM.
6. Select the Federation tab on the right pane. The supported CI Types are shown in the Supported
and Selected CI Types section. You can click Expand all in the toolbar to view all CI Types at a
glance.
Note:
o
Most CI Types supported by the integration are UDM compliant, except for Printer and
those CI Types under Node.
o
Those grayed CI Types are not supported.
o
If a CI Type is supported, all its children CI Types are automatically supported.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 59 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 2: HP Asset Manager Population Integration
Supported CI attributes and the mapping with the AM
fields
For each CI Type supported by the integration, below are the mappings between the UCMDB CI attribute
and AM field. For each CI attribute, its compliance with BTO Data Model (UDM) 1.1 is also identified.
CI Type: Asset
UCMDB attribute
AM field
UDM entity?
asset_tag
amPortfolio.asset_tag
Yes
description
amAsset.AssetSerialNo
Yes
id1
amPortfolio.lPortfolioItemId
No
assignment
amPortfolio.seAssignment
Yes
CI Type: IpAddress
UCMDB attribute
AM field
UDM entity?
id1
amNetworkCard.lNetworkCardId
No
ip_address
amNetworkCard.TcpIpAddress
No
ip_address_property
View_amNetworkCard.ip_address_property
Yes
ip_address_value
View_amNetworkCard.ip_address_value
Yes
ip_dhcpdomainname
amNetworkCard.DHCPServer
No
ip_isdhcp
amNetworkCard.BDHCPEnabled
No
ip_netmask
amNetworkCard.SubnetMask
No
name
amNetworkCard.TcpIpAddress
Yes
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 60 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 2: HP Asset Manager Population Integration
CI Type: Node
All the children CIs of the Node CI inherit the same attribute from the Node CI. In particular these CI
Types are relevant with the integration:
l
Computer
l
Windows
l
Unix
l
Mainframe
l
Firewall
l
Router
l
Switch
l
ATM Switch
l
Net Printer
UCMDB attribute
AM field
UDM entity?
asset_tag
amPortfolio.AssetTag
Yes
create_time
amPortfolio.dtRecCreation
Yes
data_externalid
amComputer.lComputerId
No
data_note
amPortfolio.seAssignment
No
default_gateway_ip_address
amNetworkCard.DefaultGateway
Yes
description
amAsset.Description
Yes
discovered_os_name
amComputer.OperatingSystem
Yes
discovered_os_version
amComputer.OSServiceLevel
Yes
host_isdesktop
amComputer.ComputerType
No
host_isvirtual
amComputer.ComputerType
No
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 61 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 2: HP Asset Manager Population Integration
UCMDB attribute
AM field
UDM entity?
id1
amComputer.lItemId
No
last_modified_time
amComputer.dtLastModif
Yes
memory_size
amComputer.lMemorySizeMb
Yes
name
amComputer.TcpIpHostName
Yes
node_model
amModel.ModelName
Yes
node_role
amComputer.ComputerType
Yes
primary_dns_name
amComputer.TcpIpDomain
Yes
serial_number
amAsset.SerialNo
Yes
globalid
amPortfolio.CMDBId
Yes
CI Type: CPU
UCMDB attribute
AM field
UDM entity?
core_number
amComputer.lCPUCoreNumber
No
cpu_id
amComputer.lComputerId
Yes
cpu_speed
amComputer.lCPUSpeedMHz
No
id1
amComputer.lItemId
No
name
amComputer.Name
Yes
cpu_clock_speed
amComputer.lCPUSpeedMHz
Yes
CI Type: DiskDevice
UCMDB attribute
AM field
UDM entity?
Id1
amPhysicalDrive.lPhysDriveId
No
name
amPhysicalDrive.Description
Yes
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 62 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 2: HP Asset Manager Population Integration
CI Type: FileSystem
UCMDB attribute
AM field
UDM entity?
disk_size
amPhysicalDrive.lTotalSizeMb
No
Id1
amPhysicalDrive.lPhysDriveId
No
name
amPhysicalDrive.Description
Yes
CI Type: InstalledSoftware
UCMDB attribute
AM field
UDM entity?
description
Model.comment.memComment
Yes
File_system_path
amSoftInstall.Folder
Yes
id1
amSoftInstall.lSoftInstId
No
Name
amModel.Name
Yes
Vendor
amBrand.Name
Yes
Version
amSoftInstall.VersionLevel
Yes
CI Type: Interface
UCMDB attribute
AM field
UDM entity?
id1
amNetworkCard.lNetworkCardId
No
interface_description
amNetworkCard.Description
Yes
mac_address
amNetworkCard.PhysAddress
Yes
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 63 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 2: HP Asset Manager Population Integration
CI Type: LogicalVolume
UCMDB attribute
AM field
UDM entity?
id1
amLogicalDrive.lLogDriveId
No
logicalvolume_free
amLogicalDrive.lFreeSpaceMb
No
logicalvolume_fstype
amLogicalDrive.Media
No
logicalvolume_size
amLogicalDrive.lTotalSizeMb
No
Name
amLogicalDrive.MountPoint
Yes
CI Type: Printer
UCMDB attribute
AM field
UDM entity?
id1
amPortfolio.lPortfolioItemId
No
name
amPortfolio.ModelName
Yes
CI Type: Location
UCMDB attribute
AM field
UDM entity?
id1
amLocation.lLocaId
No
location_type
amLocation.LocationType
Yes
name
amLocation.FullName
Yes
Location_bar_code
amLocation.BarCode
Yes
CI Type: BusinessElement
UCMDB attribute
AM field
UDM entity?
Id1
amPortfolio. lPortfolioItemId
No
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 64 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 2: HP Asset Manager Population Integration
UCMDB attribute
AM field
UDM entity?
Name
amAsset.AssetTag
Yes
last_modified_time
amPortfolio.dtLastModif
Yes
create_time
amPortfolio.dtRecCreation
Yes
description
amAsset.Description
Yes
data_note
amAsset.Status
No
global_id
amPortfolio.CMDBId
Yes
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 65 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 2: HP Asset Manager Population Integration
The configuration files used by the integration
This section describes the configuration files used by the integration.
Where are the configuration files located
The configuration files that are relevant with the integration are located in the following path in UCMDB:
Data Flow Management\Adapter Management\AMAdapter\Configuration Files
discriminator.properties
When a CI is populated to UCMDB, its CI Type is defined according to the value of
amComputer:ComputerType in AM.
This file defines the mapping between the values of amComputer:ComputerType and the UCMDB CI
Type.
A summary of the mapping can be found at the following location: "What CI data is populated from AM
to UCMDB?" on page 53.
server_virtual_distinguisher.properties
When a CI is populated to UCMDB, the Host is Virtual attribute of the CI is defined according to the
value of amComputer:ComputerType for the CI in AM.
This file defines the mapping between the values of amComputer:ComputerType and the Host is
Virtual attribute.
If the value of amComputer:ComputerType in AM is...
the value of Host is Virtual in UCMDB is...
Virtual Machine
Virtual Machine
l
Windows computer
l
Windows desktop computer
l
VMware Virtual Center
l
VMware ESX server
HP Universal CMDB (Content Pack 17.00 (CP17))
No
Page 66 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 2: HP Asset Manager Population Integration
If the value of amComputer:ComputerType in AM is...
l
Unix server computer
l
Unix desktop computer
l
Solaris Zone Server
l
Desktop computers
l
Computer servers
l
Laptop
l
Mainframe
l
ATM switch
l
Firewall
l
Router
l
Switch
l
Network printer
the value of Host is Virtual in UCMDB is...
server_desktop_distinguisher.properties
When a CI is populated to UCMDB, the Host is Desktop attribute of the CI is defined according to the
value of amComputer:ComputerType for the CI in AM.
This file defines the mapping between the values of amComputer:ComputerType and the Host is
Desktop attribute.
If the value of amComputer:ComputerType in AM
is...
l
Windows desktop computer
l
Unix desktop computer
l
Desktop computers
l
Windows computer
HP Universal CMDB (Content Pack 17.00 (CP17))
the value of Host is Desktop in UCMDB
is...
Yes
No
Page 67 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 2: HP Asset Manager Population Integration
If the value of amComputer:ComputerType in AM
is...
l
VMware Virtual Center
l
VMware ESX server
l
Unix server computer
l
Solaris Zone Server
l
Computer servers
l
Laptop
l
Mainframe
l
ATM switch
l
Firewall
l
Router
l
Switch
l
Network printer
the value of Host is Desktop in UCMDB
is...
fixed_values.txt
When populating IP address data from AM to UCMDB, the IpAddress:routing_domain attribute value of
the IP Address CI Type is populated with DefaultDomain.
This file allows you to change the default value for the attribute.
location_type_transformer.xml
This file contains all the mappings between location types in AM and UCMDB. Mapping for a location type
is represented by an entry like this:
<value cmdb-value= "room" external -db-value="room"/>
The UCDMB location type is the value for the cmdb-value attribute, while the AM location type is the
value for the external-db-value attribute.
All the AM location types must be mapped with those in UCMDB for the data population to be successful.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 68 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 2: HP Asset Manager Population Integration
condition_rules.xml
Out-of-the-box, this file defines the basic rules to decide what kind of CIs can be populated from AM to
UCMDB and remove CIs from UCMDB.
Out-of-the-box, only amComputer records whose associated Portfolio Item is in stock
(amPortfolio:seAssignment = In stock) can be populated to UCMDB as Node CIs.
This file allows you to customize the assignments (amPortfolio:seAssignment) computers could have
for them to be populated.
This configuration file uses values stored in the AM database to designate the value of the
seAssignment field. Refer to the following table for the relationship between the value stored in the
database and the displayed value.
Value stored in the displayed
Actual displayed text for seAssignment
0
In use
1
In stock
2
Retired
3
Awaiting receipt
4
Return for maintenance
5
Return to supplier
6
Missing
You can designate multiple values in this file to allow populating computers with different assignments
to UCMDB.
Find the statement:
<expression join="AND" field="data_note" data-type="INTEGER" operator="IN"
value="0,1"/>
This means it will only add/update those Node CIs whose data_note (amPortfolio.seAssignment) is 0 (In
use) or 1 (In stock).
Find the statement:
<expression join="NOT" field="data_note" data-type="INTEGER" operator="IN"
value="0,1"/>
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 69 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 2: HP Asset Manager Population Integration
This means it will only remove those Node CIs whose data_note is not in the list of 0 and 1.
Note: Keep the same value for these two expressions.
This means that computers with the assignments (amPortfolio:seAssignment) In use and In stock can
be populated to UCMDB. If you change their assignment to other values in AM, the corresponding CIs will
be deleted when you run the population job next time (see "What happens when changes occur in AM
during data population?" on page 59).
Global_id_mapping.properties
Make sure Push back ID is enabled when creating the integration point. Define how to write global_id
back to AM. By default, global_id is saved in the amPortfolio.CMDBId field.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 70 of 366
Chapter 3: HP Asset Manager Push Integration
This chapter includes:
Quick Start
72
Overview
72
Supported Versions
74
How to Integrate UCMDB and Asset Manager
75
Validate Pre-Loaded Data in Asset Manager
75
Set Up Asset Manager
75
Set Up UCMDB
80
Push CI Data from UCMDB to Asset Manager
83
How to View UCMDB Data in Asset Manager
89
Nodes
89
Business Elements
90
How to Schedule Data Push Jobs
90
Installed Software / Software Utilization
92
How to Tailor the Integration
95
Integration Architecture
96
How to Change Adapter Settings
105
How to Customize an Existing Mapping
107
How to Add a New Mapping to the Integration
109
Frequently Asked Questions
112
Troubleshooting and Limitations
116
Logs
HP Universal CMDB (Content Pack 17.00 (CP17))
121
Page 71 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
Quick Start
Note: This section is only for advanced users who want to start using Asset Manager Push
Integration quickly, without reading the full documentation. It therefore provides the minimum
information required before you run your first integration.
Before starting the integration for the first time, you must complete the following:
l
"Validate Pre-Loaded Data in Asset Manager" on page 75
l
"Update Asset Manager Schema" on page 77
l
"Create AMPushAdapterAPI Package with Required AM API Files" on page 80
l
"Install a Database Client" on page 80
Overview
Integration between HP Universal CMDB (UCMDB) and HP Asset Manager enables you to share
information from UCMDB with Asset Manager. Common use cases include Hardware, Installed Software
and Business Services.
You can use the integration to automate the creation and update of Asset and Portfolio information in
Asset Manager. This ensures Asset Manager is kept up to date with real, accurate, discovered data in
your environment.
Note: This Integration replaces the Connect-It Scenarios used for syncing Hardware and Software
information from DDMI 9.3x and below to Asset Manager. Also, this integration replaces the
Connect-It Scenarios used to sync Business Services and Business Applications from UCMDB to
Asset Manager.
Note: In UCMDB 10.20 CP 15 and greater versions, a new Asset Manager adapter named Generic
Adapter is introduced for exchanging data between Asset Manager and UCMDB. It bundles 3 core
features of the AM and UCMDB integration in a single adapter: population, federation, and push.
We strongly recommend that you use the Generic Adapter instead of the combination of the two
conventional adapters (population and push). For more information about how to use the Generic
Adapter, see "HP Asset Manager Integration with the AM Generic Adapter" on page 122.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 72 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
How Data is Synchronized Between UCMDB and Asset Manager
When referring to the concept of data information, it is important to distinguish between a UCMDB CI
(Configuration Item) and an Asset Manager Asset. Both are defined in a different Data Model, and there
must be a conversion before transferring CIs in UCMDB to Assets in Asset Manager.
The following graphic shows the high-level components of the integration:
Note: The Push Adapter and AM Connector are executed in the Data Flow Probe/Integration Service
process.
UCMDB stores its information using CIs. The integration chooses which data to pull from UCMDB by
defining integration TQL queries. Each TQL query defines a superset of data relevant for the integration.
The UCMDB Push Engine:
l
Retrieves the required data from UCMDB, using the given TQL query.
l
Filters the data to include only the data that has changed since the last execution of this
synchronization.
l
Splits the data into multiple chunks without breaking consistency.
l
Sends the information to the Probe/Adapter
The Push Adapter is a generic framework for easily configuring push adapters, using only XML and
Groovy1. It allows easy mapping of the data from the UCMDB data model into the Asset Manager Data
1Groovy is an agile and dynamic language, natively supported by the Java Virtual Machine. It allows
simple scripting capabilities, while maintaining all the strengths and capabilities of Java. It can execute
simple String manipulation, and use 3rd party libraries. For more information, see http://groovy.codehaus.org/
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 73 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
model, and the transfer of this converted data into the AM Connector. For more information, see
Developing Push Adapters in the HP Universal CMDB Developer Reference Guide.
The AM Connector is a component that connects to the Push Adapter, built specifically to reconcile,
push, and handle the complex logic needed to synchronize data into Asset Manager.
Supported Versions
This integration supports HP Asset Manager 9.30 and later versions.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 74 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
How to Integrate UCMDB and Asset Manager
To set up integration between UCMDB and Asset Manager, you must complete the following steps:
l
"Validate Pre-Loaded Data in Asset Manager" below
l
"Set Up Asset Manager" below
l
"Set Up UCMDB" on page 80
l
"Push CI Data from UCMDB to Asset Manager" on page 83
Validate Pre-Loaded Data in Asset Manager
For the integration to succeed, it requires there to be some basic data already in the Asset Manager
database.
This data may either be imported during the database creation (using the Asset Manager Application
Designer), or may be added later. For more information, see the Asset Manager Documentation –
Administration.
For hardware synchronization the required data is:
l
Shared Data
l
UNSPSC Product Classification
l
Portfolio – Line-of-business data
l
Virtualization – Line-of-business data
l
Business services management – Line-of-business data
For software synchronization the required data is:
l
Software Asset Management – Line-of-business data
Set Up Asset Manager
To set up Asset Manager you must complete the following steps:
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 75 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
Create an Account with Administrative Rights
For the integration, any user with administrative rights will suffice. Asset Manager OOTB installations
include an administrator account.
The details of the default Administrator user are:
l
User: Admin
l
Password: <empty>
The following example shows how to create a new user (named Integration-Admin) with administration
rights, specifically for the integration.
1. Log on to Asset Manager as an administrator.
2. Go to Organization Management > User actions > Add a user.
a. In ID #, type: Integration-Admin.
b. In Name, type: Integration-Admin.
c. In First, type: Integration-Admin.
d. Click Next.
e. Click Next.
f. Click Finish.
3. Go to Organization Management > Organization > Employees.
4. Select the newly created User and go to the Profile tab.
5. In User name, type: Integration-Admin.
6. In Password, type: <A password you would like to use>.
7. In the Password Administration pane, ensure Never Expires is selected.
8. In the Profile pane, ensure Administration rights is selected.
9. Click Modify.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 76 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
Update Asset Manager Schema
The default Asset Manager database schema includes column lengths that may be significantly shorter
than their counterparts in the UCMDB database schema. For attributes used for reconciliation, this may
be critical and may cause creation of multiple records.
To fix this issue, you are recommended to change the Asset Manager Column Sizes to the values shown
in the following table of Asset Manager Attributes.
Default Max Length
New Value
New Value as of AM 9.31[*]
TcpIpHostName
40
255
255
amComputer
WorkGroup
40
250
250
amPortfolio
Folder
128
250
250
amAsset
SerialNo
36
250
250
amModel
Name
80
250
250
amCompany
Name
30
100
100
amSoftInstall
Folder
128
255
255
amSoftInstall
Field1
26
255
255
amSoftInstall
TechnicalInfo
128
255
255
amBrand
Name
64
250
250
amEmplDept
UserName
100
200
200
amEmplDept
UserDomain
100
200
200
amBrand
FullName
500
amComputer
FullName
500
amModel
FullName
500
Table
Name
amComputer
[*] Also available in Asset Manager versions 5.22 and 9.3 with an appropriate hotfix for column length
limit.
Note:
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 77 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
l
The new values in the table are only a suggestion, and you may need to change them according
to actual data per customer use case.
l
DB2 default table space page size of 4K may be too small in some cases; using 8K or higher is
recommended.
Prepare Asset Manager for Parallel Push
Enabling Parallel Push significantly increases the performance of the push. However, some advance
preparation is necessary. Different actions are needed for different database types, as shown in the
following table:
Database Action
DB2
Mandatory: follow Eliminating locks and deadlocks in the Asset Manager Tuning Guide.
Limitation: DB2 parallel push is not supported in UCMDB 10.01.
Oracle
Optional: follow Eliminating locks and deadlocks in the Asset Manager Tuning Guide.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 78 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
Database Action
SQL
Server
The following are all mandatory steps:
1. Alter the SQLServer Schema isolation level:
Execute the following command on the database, replacing <AMSchema> with the
real schema name:
ALTER DATABASE <AMSchema> SET READ_COMMITTED_SNAPSHOT ON
ALTER DATABASE <AMSchema> SET ALLOW_SNAPSHOT_ISOLATION ON
GO
Note: If the execution takes too long, you may need to disconnect all connections to
the database. One possible way is to restart the database service, then execute the
command. If you restart the SQL Server, and an Integration Point has already been
created in UCMDB, you should restart the UCMDB Probe as well to avoid the issue of
dead connections.
2. Alter Asset Manager database options:
a. Open the Asset Manager Client and connect to the appropriate database schema
b. Navigate on the top menus to Administration > Database options
c. For option ‘Sql Server specifics’|‘Isolation command before starting a write
transaction’change the current value to set transaction isolation level snapshot
3. Create a table for each of the following counters. To do this, follow the instructions in
the Eliminating locks and deadlocks chapter of the Asset Manager Tuning Guide.
o
amAsset_AssetTag
o
amBrand_BarCode
o
amModel_BarCode
o
amModel_ModelRef
o
amAssignment_Code
o
amEmplDept_BarCode
o
amComputer_Group
o
amComputer_Domain
o
amComputer_Vm
o
amComputer_MD
o
amComputer_Name
o
amSoftInstall_Code
o
amMonitor_Serial
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 79 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
Set Up UCMDB
To set up UCMDB you must complete the following steps:
Create AMPushAdapterAPI Package with Required AM API Files
Note: If you want to create several integrations to different versions of Asset Manager, follow
this procedure for each version of Asset Manager you want to integrate to. Otherwise, see "Set Up
UCMDB" above.
In order for the adapter to connect to the appropriate Asset Manager version, you must supply the Data
Flow Probe/Integration Service with the appropriate Asset Manager API DLLs and Jars, as follows:
1. Copy the files below:
o
<Asset Manager Installation folder>\x64\*.dll
o
<Asset Manager Installation folder>\websvc\lib\*.jar
2. Create a package called AMPushAdapterAPI_<AM Version Number>.zip. For example, for version
9.3 the package is AMPushAdapterAPI_9.3.zip.
3. Paste the copied files to:
<AMPushAdapterAPI_{AM Version
Number}.zip>\discoveryResources\AMPushAdapter\amVersion\<AM Version Number>
For example, for version 9.3 the path is:
AMPushAdapterAPI_9.3.zip\discoveryResources\AMPushAdapter\amVersion\9.3
4. Add the subfolder AMPushAdapter/amVersion/<AM Version Number>/*.* to the
additionalClasspath property in the globalSettings.xml file.
5. Deploy the AMPushAdapterAPI_<AM Version Number>.zip package.
Install a Database Client
You must install database client software according to the type of database the Asset Manager schema
is installed on, as detailed in the following table:
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 80 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
Database Client Software
DB2
1. Download and Install “IBM Data Server Client” 64 bit for windows on your Data Flow
Probe/Integration Service computer. This may be downloaded from:
http://www-01.ibm.com/support/docview.wss?rs=4020&uid=swg21385217
2. Create a connection to the DB2 database of Asset Manager.
You may create this using the DB2 Control Center.
Note: Remember the Database Alias you define in the connection, because you
need it when creating the integration point.
3. Copy the db2cli64.dll file from the DB2 client bin directory (By default: C:\Program
Files\IBM\SQLLIB\BIN) to the <Data Flow Probe/Integration Service>\lib folder.
4. Restart the Data Flow Probe/Integration Service.
Oracle
Oracle client windows 64 bit
For example: Oracle Database 11g Release 2 Client (11.2.0.1.0) for Microsoft Windows
(x64).
1. Download the client installation from:
http://www.oracle.com/technetwork/database/enterpriseedition/downloads/index.html
2. Install the client, in Administrator mode, on the Data Flow Probe/Integration Service
computer.
3. Copy oci.dll from the <Oracle Client installation directory> into:
<Probe/Integration Service installation directory>\lib.
4. Restart the Data Flow Probe/Integration Service.
SQL
None required.
Server
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 81 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
Create an Integration Point in UCMDB
1. Log on to UCMDB as an administrator.
2. Go to Data Flow Management > Integration Studio. UCMDB displays a list of existing integration
points.
3. Click the
button. The New Integration Point dialog box is displayed.
4. Complete the Integration and Adapter Properties fields as shown in the following table:
Field
Required Description
Integration
Yes
Type the name (unique key) of the integration point.
No
Type a description of the current integration point.
Adapter
Yes
Select HP Software Products > Asset Manager > Asset Manager
Push Adapter
Is
Yes
Select this option to indicate the integration point is active.
Hostname/IP
Yes
Type the hostname or IP Address of the Asset Manager database.
DB Type
Yes
Select the database type your Asset Manager schema is located on.
DB Port
Yes
Type the communication port of the Asset Manager Data Base.
Name
Integration
Description
Integration
Activated
DB Name/SID Yes
o
DB2: type in the name of the Database Alias you defined in the
database connection.
o
o
Oracle: type the service name.
SQL Server: type the name of the schema.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 82 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
Field
Required Description
Credentials
Yes
Select Asset Manager Protocol. To create a new protocol, click the
ID
AM Version
button. Under Asset Manager Protocol complete:
Yes
o
Asset Manager User Name: An AM administrator's user name.
o
Asset Manager Password: An AM administrator's password.
o
DB User Name: The AM database user's name.
o
DB Password: The AM database user's password.
Select the version of Asset Manager this integration point is to
connect to.
Enable
Yes
Parallel Push
Select to allow parallel (multi-threaded) data push to Asset Manager.
This improves performance. Note that you must configure SQL Server
& DB2 to support parallel push. See "Prepare Asset Manager for
Parallel Push".
Data Flow
Yes
Probe
Additional
Probes
Select the name of the Data Flow Probe/Integration service used to
execute the synchronization from.
No
Select additional probes to use when pushing to AM in order to
increase redundancy.
5. Click Test Connection to make sure there is a valid connection.
6. Click OK.
The integration point is created and its detailed are displayed.
UCMDB creates a default data push job when creating the integration point. If needed you may
create or edit the existing job. For more information, see "Work with Data Push Jobs" in the HP
Universal CMDB Data Flow Management Guide.
Push CI Data from UCMDB to Asset Manager
Data push jobs copy CI or CI relationship records from your UCMDB system to your Asset Manager
system. To run a data push job, complete the following steps:
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 83 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
1. Log on to UCMDB as an administrator.
2. Go to Data Flow Management > Integration Studio. UCMDB displays a list of existing integration
points.
3. Select the integration point you created for Asset Manager.
4. Add a new data push job as follows:
a. Click the
button on the right panel.
b. In the Name field, type a unique name for the job.
c. Click the
button to add existing TQL queries to the job.
UCMDB Creates a default data push job when creating an integration point.The following table
lists the Topology Query Language (TQL) queries in the default data push job. If required, you
may create, update, or remove TQL queries for the push job. You may also need to update the
mapping. See "How to Customize an Existing Mapping" on page 107. To access these OOTB TQL
queries for push, go to Modeling > Modeling Studio > Resources, select Queries for Resource
Type and then go to Root > Integration > AM Push.
Note: If you want to use cluster with Asset Manager, you must install the latest version of
the SAM Best Practice package in Asset Manager.
TQL Query
Description
AM Business
Pushes Business Applications, Business Services and Business
Element Push
Infrastructure CIs.
Mapping XML: pushMappingAMBusinessElement.xml
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 84 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
TQL Query
Description
AM Business
Pushes relationships between Business Elements (pushed by AM
Element
Business Element Push Query) to other business elements or to nodes.
Relations Push
Business Elements must have been pushed before this TQL query
synchronization in the ‘AM Business Element Push’ TQL query
synchronization.
Nodes must have been pushed before this TQL query synchronization in
the ‘AM Computer Push’ TQL query synchronization.
Mapping XML: pushMappingBeRelations.xml
AM Computer
Pushes nodes (Computers, Network Devices, etc.). Also pushes IPs,
Push
Interfaces, Disk Devices, Physical Ports, Hardware Boards, Display
Monitors, CPUs, Printers, Inventory Scanners, File Systems, and Assets.
Minimal attributes for pushing a Node:
l
Serial Number
l
Vendor or Discovered Vendor
l
Model or Discovered Model
l
Node Role
Note: These are required values, and depend on the capability
of the data source to report them.
Mapping XML: pushMappingAMCoumputer.xml
AM Computer
Pushes relationships between Computers to any node (Computers,
Relations Push
Network Devices, etc.).
Nodes must have been pushed before this TQL query synchronization in
the ‘AM Computer Push’ TQL query synchronization.
Mapping XML: pushMappingAMComputerRelations.xml
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 85 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
TQL Query
Description
AM Host Server
Pushes relationships between Host and Guest (virtualized) systems of
And Running LPAR
LPAR type. Nodes must have been pushed before this TQL query
VM Relations
synchronization in the 'AM Computer Push' TQL query synchronization.
Push
Mapping XML: pushMappingHostToVMLpar.xml
AM Host Server
Pushes relationships between Solaris Host and Guest (Virtualized)
And Running
operating systems.
Solaris VM
Relations Push
Nodes must have been pushed before this TQL query synchronization in
the ‘AM Computer Push’ TQL query synchronization.
Mapping XML: pushMappingHostToVMSolaris.xml
AM Host Server
Pushes relationships between Host and Guest (Virtualized) operating
And Running VM
systems.
Relations Push
Nodes must have been pushed before this TQL query synchronization in
the ‘AM Computer Push’ TQL query synchronization.
Mapping XML: pushMappingHostToVM.xml
AM Installed
Pushes Installed Software CIs.
Software Push
Nodes must have been pushed before this TQL query synchronization in
the ‘AM Computer Push’ TQL query synchronization.
Mapping XML: pushMappingNormalizedSW.xml
(Possible alternate mapping:
pushMappingSWNonNorm.xml
See "Installed Software / Software Utilization" on page 92.)
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 86 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
TQL Query
Description
AM Software
Pushes User_Software_Utilization CIs.
Utilization Push
Nodes must have been pushed before this TQL query synchronization in
the ‘AM Computer Push’ TQL query synchronization.
Mapping XML: pushMappingNormalizedSWUtil.xml
(Possible alternate mapping:
pushMappingSWUtilNonNorm.xml
See "Installed Software / Software Utilization" on page 92.)
AM Net Device
Pushes relationships between Network Devices to Network Devices.
Relations Push
Nodes must have been pushed before this TQL query synchronization in
the ‘AM Computer Push’ TQL query synchronization.
Mapping XML: pushMappingAMNetDeviceConnections.xml
AM Oracle LMS
Pushes the Oracle Running Software and its Oracle LMS data.
Push
Nodes must have been pushed before this TQL query synchronization in
the ‘AM Computer Push’ TQL query synchronization.
Mapping XML: pushMappingOracleLMS.xml
AM Software Sync
Pushes Hypervisor Installed Software.
Hypervisor
Nodes must have been pushed before this TQL query synchronization in
the ‘AM Computer Push’ TQL query synchronization.
Mapping XML: pushMappingHypervisor.xml
AM Cluster Push
Pushes Cluster CIs
Nodes must have been pushed before this TQL query synchronization in
the ‘AM Computer Push’ TQL query synchronization.
Mapping XML: pushMappingCluster.xml
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 87 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
TQL Query
Description
AM Cluster Node
Pushes cluster relations between Computer Elements (pushed by AM
Relations Push
Computer Push) and Cluster.
Cluster Elements must have been pushed before this TQL query
synchronization in the ‘AM Cluster Push’ TQL query synchronization.
Nodes must have been pushed before this TQL query synchronization in
the ‘AM Computer Push’ TQL query synchronization.
Mapping XML: pushMappingClusterNodeRelations.xml
AM Cluster
Pushes Cluster Runningsoftware CIs
Runningsoftware
Push
Nodes must have been pushed before this TQL query synchronization in
the ‘AM Cluster Push’ TQL query synchronization.
Mapping XML: pushMappingClusterRunningsoftware.xml
AM Cluster
Pushes cluster runningsoftware relations between Computer Elements
Runningsoftware
(pushed by AM Computer Push) and Cluster.
Relations Push
Cluster Runningsoftware Elements must have been pushed before this
TQL query synchronization in the ‘AM Cluster Runningsoftware Push’
TQL query synchronization.
Nodes must have been pushed before this TQL query synchronization in
the ‘AM Computer Push’ TQL query synchronization.
Mapping XML: pushMappingClusterRunningsoftwareRelations.xml
d. Select or unselect the Allow Deletion option for each query. (The setting determines if this
TQL query is allowed to delete data from Asset Manager, though the actual action on delete is
defined by CI type in the mapping xml.)
Note: For scheduling configuration, see "How to Schedule Data Push Jobs" on page 90.
e. Click OK.
f. Save the integration point.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 88 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
5. Run the job manually to see if the integration job works properly:
a. To push all the relevant data for the job, click the
button.
b. To push only the changes in the data since the job last executed, click the
6. Wait for the job to complete; click the
button.
button multiple times as needed until the job is
completed.
7. When the job is completed, the job status becomes one of the following depending on the results:
o
Succeeded
o
Completed
o
Failed
8. Click the Statistics tab to view the results; if any errors occur, click the Query Status tab and Job
Errors tab for more information. For more information about errors, see "Troubleshooting and
Limitations".
Note: For details about these tabs and managing the integration, see Integration Jobs Pane in
the HP Universal CMDB Data Flow Management Guide.
If the job completes successfully, you can view the UCMDB CI data in Asset Manager.
How to View UCMDB Data in Asset Manager
After a push job is successfully completed, you can search for and verify that the pushed CI/relationship
data is in Asset Manager.
Nodes
This includes computers, network devices, etc.
To view:
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 89 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
1. Log on to Asset Manager as an administrator.
2. Go to Portfolio Management > Asset Configurations > IT equipment > Computers and virtual
machines.
3. In the opened dialog box, for IP name, type the name of the computer you are searching for.
4. You may use ‘<name prefix>%’ for easier searching. For example, searching IP name for mycomp%
returns computer mycomp1, mycomp2, etc.
5. Browse the computer for the different data.
Business Elements
This includes Business Applications, Business Services and Business Infrastructures.
1. Log on to Asset Manager as an administrator.
2. Go to Asset Lifecycle > IT Services and virtualization > Business services > Business services.
3. Browse the different Services.
For more information about viewing data in Asset Manager, see the Asset Manager Documentation.
How to Schedule Data Push Jobs
UCMDB allows you to schedule job executions directly from a data push job.
1. Log on to UCMDB as an administrator.
2. Go to Data Flow Management > Integration Studio. UCMDB displays a list of existing integration
points.
3. Select the integration point you created for the UCMDB - AM integration.
4. Select the push job.
5. Click the
button.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 90 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
Note: UCMDB allows you to define two different schedules for two types of data push:
Changes Synchronization and All Data Synchronization. It is recommended to use the
Changes Sync schedule to only synchronize changes and avoid synchronizing the entire set of
data each time.
6. Define a schedule for Changes Sync.
a. Click on the Changes Synchronization tab.
b. Select the Scheduler enabled option.
c. Select the scheduling options you want to use.
7. Click the All Data Synchronization tab and select the scheduling options you want to use.
8. Click OK.
9. Save the integration point.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 91 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
Installed Software / Software Utilization
The Integration supports the following different flows for pushing Installed Software or Software
Utilization to Asset Manager. You may switch between these flows.
Note: The following sections describe three different flows for Installed Software. The same flows
also apply to Software Utilization (User_Software_Utilization).
Note: The flows below show a simplified high-level flow of the different Installed Software or
Software Utilization synchronization behavior. The actual behavior may be more complex in some
cases, mainly for performance improvement. See also "Switching between Installed Software
Flows" on page 94 and "Switching between Software Utilization Flows" on page 94.
Normalized Installed Software
This flow uses an InventoryModel to catalog each exact Software Version. Therefore, if the AM Operator
decides to map a certain Software version to a different model, he only has to do it once to the
Inventory Model, and does not have to process all the Installed Software in AM. This flow allows using
either the SAI Version ID, or the attributes name, version, and vendor, to correctly reconcile the Installed
Software, and uses the information to automatically create Models according to major versions as
needed.
1. Each Installed Software is first mapped to an Inventory Model. If one does not exist, it creates one.
The mapping is done according to the SAI Version ID which is an inventory ID from the Universal
Discovery Scanner, or by using the Installed Software's name, version, and vendor.
2. It then sees if the InventoryModel has a final mapping to a Model. If it is a new InventoryModel, or
the InventoryModel has no final mapping to a Model, it attempts to search for one with the same
name and version. If one is found, it connects the InventoryModel to it; otherwise it creates a new
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 92 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
Model.
3. It then connects the Installed Software to the Model as well.
Note: Normalized Installed Software is the default flow.
Normalized Installed Software – No Model Creation
This flow uses an InventoryModel to catalog each exact Software Version. Therefore, if the AM Operator
decides to map certain Software version to a different model, he only has to do it once to the
InventoryModel, and does not have to process all the Installed Software in AM. This flow does not
automatically create a Model. Instead, the Model must be connected to the InventoryModel by a
different flow, or manually by an Asset Manager Operator.
1. Each Installed Software is first mapped to an Inventory Model. If one does not exist, it creates one.
The mapping is done according to the SAI Version ID, which is an inventory ID from the Universal
Discovery Scanner, or by using the Installed Software attributes: name, version, and vendor.
2. It then sees if the InventoryModel has a final mapping to a Model. If not, it chooses the temporary
model (an Unknown Software Model).
3. It then connects the Installed Software to the Model found in the step 2.
4. Later, an Asset Manager Operator manually connects each Inventory Model to a final Model, as he
wishes.
Non-Normalized Installed Software
This flow pushes Installed Software and Models only. (It does not map or use the Inventory Models in any
way).
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 93 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
Each Installed Software is mapped to a matching Model which is created if not found.
Switching between Installed Software Flows
Switching to Normalized Installed Software Flow
This is the default flow, enabled OOTB for this integration. If the flow was changed and you would like to
return to this flow:
l
Change the Installed Software push TQL query name (original name: AM Software Push) to
AM Installed Software Push.
Switching to Normalized Installed Software – No Model Creation
In Adapter Management, edit am-push-mapping.xml:
1. Go to ci-type="Complete_amModel"
2. Change operation-type to optional_reference
Switching to Non-Normalized Installed Software
Change the Installed Software push TQL query name (original name: AM Installed Software Push) name
to: AM Software Non Norm.
Switching between Software Utilization Flows
Switching to Normalized Software Utilization Flow
This is the default flow, enabled OOTB for this integration. If the flow was changed and you would like to
return to this flow:
l
Change the Software Utilization push TQL query name (original name: AM Software Utilization Non
Norm) to AM Software Utilization.
Switching to Normalized Software Utilization – No Model Creation
In Adapter Management, edit am-push-mapping.xml:
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 94 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
1. Go to ci-type="Complete_amModel"
2. Change operation-type to optional_reference
Switching to Non-Normalized Software Utilization
Change the Software Utilization push TQL query name (original name: AM Software Utilization ) name to:
AM Software Utilization Non Norm.
How to Tailor the Integration
This section includes:
l
"Integration Architecture" on the next page
l
"How to Change Adapter Settings" on page 105
l
"How to Customize an Existing Mapping" on page 107
l
"How to Add a New Mapping to the Integration" on page 109
Note: For more detailed information about customizing the mapping, see "Developing Enhanced
Generic Push Adapters" in the HP Universal CMDB Developer Reference Guide.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 95 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
Integration Architecture
This section contains details about the architecture of the integration.
l
"Data Flow Architecture" below
l
"Integration TQL Queries" on the next page
l
"Reconciliation Proposals" on the next page
l
"Asset Manager Rules and Flows" on page 98
l
"Data Mapping" on page 98
l
"Push Mapping" on page 99
Data Flow Architecture
1. The Push Engine executes the TQL query.
2. For a differential flow, the data is compared to the last synchronized data, and only the changes
are forwarded.
3. Data is converted into Composite CIs (instances of data according to the TQL Root elements).
4. Data is then pushed to the Push Adapter.
5. The Push Adapter loads the correct mapping for the specific TQL query.
6. All dynamic_mappings are executed and saved to maps, to allow usage in the next mapping stage.
For more information, see "Developing Enhanced Generic Push Adapters" in the HP Universal CMDB
Developer Reference Guide.
7. Data is mapped from the UCMDB data Model into the AM Data model according to the mapping
XML.
8. Data is sent to the AM Connector.
9. AM Connector orders all the data in a set of dependency trees, starting with the records that do
not depend on any other record.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 96 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
10. AM Connector attempts to merge any duplicate records
11. AM Connector starts reconciling and pushing any record without any dependencies, or a record
whose dependencies have already been reconciled/pushed to Asset Manager.
a. AM Connector first tries to reconcile with existing records
b. If it finds a match, it attempts to update that record,
c. If it does not find a match, it attempts to create a new record.
12. AM Connector deletes any records it is required to delete in AM, as permitted by action-on-delete.
Integration TQL Queries
A TQL query used for the integration must contain a root query node.
Any attribute using in the mapping flow of the Push Adapter must be marked in the selected layout of
the query node.
Each TQL query may only have one mapping.
For more information, see Data Flow Management > Integration > Integration Studio > Integration
Jobs Pane.
Reconciliation Proposals
When pushing data to Asset Manager, there is an option to create a reconciliation proposal (RP). A
reconciliation proposal should be created if there is a change in a specific attribute that may need AM
Operator validation or action to support AM business processes.
The OOTB configuration creates a reconciliation proposal record when the memory size of the pushed
computer has decreased compared to the AM computer.
How to use Reconciliation Proposals
In the OOTB configuration lMemorySizeMb is marked for attribute-reconciliation. The update script calls
the updateMemorySize function. This function verifies if the memory size of the computer was
decreased. It initializes all the parameters that are passed to the function
validateReconcUpdateAdvance. Calls validateReconcUpdateAdvance and return its returned value.
validateReconcUpdateAdvance is a function that returns the value that should be set to the attribute
according to the Reconciliation Proposal status.The following table describes its parameters:
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 97 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
Parameter
Description
AMApiWrapper
The wrapper that is used to communicate with the AM.
newVal
The value of the attribute in the pushed data.
oldVal
The value of the attribute that is retrieved from AM.
recordId
The primary key of the table that the attribute belongs to.
strCode
The prefix of the code field in the reconciliation proposal.
strName
The name of the reconciliation proposal.
path
The name of the attribute.
recordTable
The table that the attribute belongs to.
validateReconcUpdateAdvancereturns the value that should be set for the attribute, according to the
Reconciliation Proposal status.
In order to create a reconciliation proposal flow on a different attribute, the following steps must be
completed:
1. Add the <attribute-reconciliation> tag for this attribute.
2. The update-script should call a new function that initializes the parameters passed to
validateReconcUpdateAdvance, and returns the value returned from
validateReconcUpdateAdvance.
Note: It is suggested to use the updateMemorySize function as a reference.
Asset Manager Rules and Flows
Asset Manager has its own set of rules and flows that are enforced by the Asset Manager API. Some
customizations may need to later these rules and flows as well. For more information, see the Asset
Manager documentation.
Data Mapping
For details, see Developing Push Adapters in the HP Universal CMDB Developer Reference Guide.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 98 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
Push Mapping
This section includes tables explaining each XML tag and the attributes available for configuration.
l
"Basic Information" below
l
"Reconciliation" on the next page
l
"Target CI Validation" on page 102
l
"Reference Attribute" on page 103
l
"Attribute Reconciliation" on page 103
l
"Action on Delete" on page 104
l
"Ignored Attributes" on page 105
Basic Information
Attributes in the <am-mapping> tag.
Attribute
Description
ci-type
Name used in push adapter mapping to recognize this record type.
primarykey
The primary key column in AM database schema.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 99 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
Attribute
Description
operation- Defines what operations may be done with the record:
type
l
insert Only allows creation of new records; if it already exists, an exception is thrown.
l
update - Only allows updates of an existing record; if it does not exist, an exception is
thrown.
l
update_else_insert - If the record exists it is updated, otherwise the record is
created.
l
reference-only - The record is only used for referencing by other record (and is not
updated). An exception is thrown if the record does not exist.
l
ignore - The record is unaffected by operations.
l
insert_else_reference - If the record does not exist, it is created. Otherwise it is only
used as a reference and is not be updated; see reference-only.
parallelpushallowed
If enabled with the enabled-parallel-push configuration of the integration point, will
mergeallowed
If enabled and this entity is an exact duplicate of another entity in the chunk, it merges
attempt to push to the entity with multiple threads in order to increase performance.
both entities into one and fixes any relevant references.
errorcode- If used together with the adapter specific errors, allows the printing of a customized
override
error message to the UI if the push or reconciliation of this entity fails.
target-citype
Real name of the AM database table to push this record to. If missing , it uses ci-type
fromversion
Use this mapping only from (and including) this version. The version is taken from the
to-version
Use this mapping only up to (and including) this version. The version is taken from the
instead.
integration point configuration.
integration point configuration.
Reconciliation
Reconciliation defined for each mapping may include more than one set of reconciliation rules. When
attempting to reconcile the record with existing ones in the AM database, the AM Connector tries each
of the reconciliation sets until it finds a matching record. Priority is defined by order of reconciliation
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 100 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
rules. If no record in the AM database matches this record, an insert operation occurs if the operation
type permits it.
Name
Type
Description
reconciliation
Tag
Parent XML tag for all reconciliation configuration.
reconciliation- Tag
keys
Represents a single reconciliation rule that may be made of one or more
attributes. All attributes inside the rule must match in order for the
reconciliation of this rule to be successful.
reconciliation- Tag
key
Represents a single attribute used for reconciliation as part of the
Ignore-case
Part of the reconciliation-key tag. Specifies that this attribute
Attribute
reconciliation-keys rule.
comparison ignores case.
reconciliation- Tag
advanced
Allows definition of the reconciliation rule by manually defining the
WHERE clause of the AQL (Asset Query Language). Uses GString (Groovy
String) to generate the replacement String. Any variable or property
defined in this record or its parent during the mapping stage (in the Push
Adapter) may be used as a variable in the GString. (See
http://groovy.codehaus.org/Strings+and+GString for more information).
Note: AMPushAdvancesReconciliationException may be thrown
inside this tag to skip to the next rule.
follow-parent
Tag
Used for defining overflow tables. See the AM documentation for more
information on overflow tables. When using follow-parent, no other
reconciliation may be used as this target CI has a 1:1 connection with its
parent, and it uses the parent reconciliation to push data to AM.
am-prefix
Attribute
Part of the follow-parent tag. Defines the name that the parent target
CI uses to reference to this table. (To find out the correct value, navigate
to AM Application Designer > Edit Links.)
Example:
<reconciliation>
<reconciliation-advanced>Portfolio.CMDBId = '${if(globalId==null) { throw new
com.hp.ucmdb.adapters.ampush.exception.
AMPushAdvancesReconciliationException
('Not enough reconciliation data') }else{ return globalId}}'
</reconciliation-advanced>
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 101 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
<reconciliation-keys>
<reconciliation-key ignore-case="true">AssetTag</reconciliation-key>
</reconciliation-keys><reconciliation-keys>
<reconciliation-key>TcpIpHostName</reconciliation-key>
<reconciliation-key>Workgroup</reconciliation-key>
</reconciliation-keys>
</reconciliation>
Target CI Validation
This tag allows the definition of a validation rule that is executed on specific attribute values: the new
one held in memory, and the old one stored in the AM database.
The following table shows the attributes of the <target-ci-validation> tag:
Name
Description
attributename
The attribute that you want to use for validation.
validationscript
A Groovy based script that returns true if this record is to be pushed, and false if it is
not to be pushed. The script may access any external Groovy code in the path in order
to run the evaluation.
failedvalidationerror-code
l
vNewVal - Attribute value of the record in memory.
l
vOldVal - Attribute value of the record in the AM database.
This optional attribute holds the error code that appears if there is a validation failure.
The arguments that can be referenced in the error message are:
l
{0} - The validated attribute name.
l
{1} - The property value in UCMDB.
l
{2} - The property value in Asset |Manager.
l
{3} - The validation script.
l
{4} - The additional message from the additional-failure-message attribute, or
'null' if there is no additional message.
additionalfailuremessage
This optional attribute holds an additional error message that can be referenced by
the error message in the properties.error file. See failed-validation-error-code,
above.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 102 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
Example:
<target-ci-validation attribute-name="dtLastScan" validationscript="mappings.scripts.AMReconciliationAdvanced.isDateAfter(vNewVal,vOldVal)"/>
Reference Attribute
A reference attribute defines a column that references another record from a different or same table.
This record is not pushed, or reconciled against existing AM database records, until this reference is
resolved. Resolved references are replaced by a reference ID that represents the primary ID of the
referenced record.
The following table shows the attributes of the <reference-attribute> tag:
Name
Description
ci-name
The CI-type of the referenced record.
datatype
The value type of the record.
name
The column in the current record that is to be populated by the reference ID.
referencedirection
According to the tree created by the Push Adapter, the value specifies if the
referenced record is a parent or child of the current record.
Example:
<reference-attribute ci-name="SW_amModel" datatype="STRING"
name="lModelId"reference-direction="child"/>
Attribute Reconciliation
This tag allows the AM connector to decide what to do with an attribute value according to the existing
value in the AM database.
The following table shows the attributes of the <attribute-reconciliation> tag:
Name
Description
attribute- The attribute to be reconciled.
name
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 103 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
Name
Description
updatescript
The script to execute in case of an update operation on the record. The returned value by
Insertscript
the groovy script will be push to AM as the value of this attribute.
l
vNewVal - Attribute value of the record in memory.
l
vOldVal - Attribute value of the record in the AM database.
The script to execute in case of an insert operation on the record. The value returned by
the Groovy script is pushed to AM as the value of this attribute.
vNewVal - Attribute value of the record in memory.
Example:
<attribute-reconciliation attribute-name="AssetTag" update-script=
"mappings.scripts.AMPushFunctions.fIsEmpty(vOldVal) ? vNewVal : vOldVal"/>
Action on Delete
This tag allows customization of the behavior on receipt of a delete notification for a record.
Note: No deletion occurs if the Allow Delete option in the job definition is disabled.
The following actions are possible
l
<ignore> - Do nothing.
l
<delete-ci> - Delete this record from the AM database.
l
<set-attribute-value> - Change the value of one or more attributes in the AM database.
Example:
<action-on-delete>
<set-attribute-value name="bMissing" datatype="BOOLEAN" value="1"/>
</action-on-delete>
Enum Attribute
This tag allows a specific enum attribute to be pushed in a serial mode, when the adapter is configured
to push data in parallel mode.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 104 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
Note: This option exists to prevent duplicate key exceptions occurring when several threads push
the same enum value.
The following table shows the attributes of the <enum-attribute> tag:
Name
Description
attribute-name
The enum attribute name.
itemized-name
The itemized list format (amOS) of the enum.
Ignored Attributes
This tag allows specific attributes to be ignored and not pushed to the AM database. This capability is
commonly used with the from-version and to-version attributes or tags, to ignore certain attributes for
specific versions of Asset Manager.
The following table shows the attributes of the <ignored-attributes> tag:
Name
Description
fromversion
Ignore this attribute only from (and including) this version. The version is taken from the
toversion
Ignore this attribute only up to (and including) this version. The version is taken from the
integration point configuration.
integration point configuration.
Example:
<ignored-attributes>
<ignored-attribute>lSeq</ignored-attribute>
</ignored-attributes>
How to Change Adapter Settings
1. Go to Data Flow Management > Adapter Management > AMPushAdapter > Adapters.
2. Right-click AMPushAdapter and click Edit Adapter Source.
3. Scroll down to the <adapter-settings> tag.
4. Edit the settings as required and click the Save button.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 105 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
The following table shows the Settings relevant to the AM Push Adapter:
Setting
Default
Description
replication.chunk.size
4,000
Defines the requested number of
CIs and Relationships sent in each
chunk. It is possible to adjust this
setting to try and improve
performance of the server and
the Probe.
replication.chunk.root.limit
850
Defines the maximum requested
number of Roots sent in each
chunk. This works with
replication.chunk.size as a
limiter on the amount of data
sent in each chunk.
PushConnector.class.name
The name of the Java class used
to load the AM Connector.
parallel.thread.pool.size
8
The amount of threads used in
Parallel Push Mode. The more
threads, the more CPU used.
Increasing the pool size may lower
performance.
mapping.size.fuse
100,000
The maximum number of records
the AM Connector may to retrieve
in <dynamic_mapping> .
transaction.deadlock.max.retry.count 15
The maximum number of
attempts the AM Connector
reconnects to the database when
deadlock occurs, network is
broken, or database is down. The
interval time is 1.5 ~ 3 seconds.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 106 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
Setting
Default
Description
am.reconnect.db.code
<!--MSSQL-->
SQLSTate:08001;
SQLSTate:08S01;
SQLSTate:01000;
<!--ORA-->
ORA-01033;
ORA-03113;
ORA-12543;
ORA-12541;
ORA-12518;
<!--DB2-->
SQL30080N;
SQL30081N;
The error codes are used to check
if the database exception is
raised by network or database
instance down. The AM Connector
will try to reconnect to the
database if one of these error
codes is received.
You can also add other error
codes to meet your requirements.
How to Customize an Existing Mapping
This example shows you how to add the BarCode/RFID attribute to the integration, including the TQL
query, Push Adapter Mapping and AM Mapping configuration. It allows the integration to both push the
BarCode/RFID attribute to Asset Manager, as well as use it for reconciliation of a Hardware Asset.
After completing the following steps, you may run the job with the customized mapping:
1.
Add the BarcodeOrRfidTag attribute to the AM Computer Push TQL query
layout.
In this step we add the attribute of the Asset CI to the integration TQL query so that we can use the
attribute and value in the mapping.
a. Go to Modeling > Modeling Studio > Resources and select the Queries Resource Type.
b. Go to Queries: Root > Integration > AM Push > AM Computer Push.
c. Select Asset, right-click and select Query Node Properties.
d. Go to the Element Layout tab.
e. Move the BarcodeOrRfidTag to the Specific Attributes box.
f. Click OK.
g. Save the Query.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 107 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
2.
Add the BarCode Mapping to the pushMappingAMComputer.xml push adapter
mapping.
In this step we take the value from the TQL result and remodel it to the Asset Manager Data Model.
a. Go to Data Flow Management > Adapter Management > Packages > AMPushAdapter >
Configuration Files > pushMapingAMComputer.xml.
b. Go to the <target_ci_type name="amComputer"> XML tag.
c. Add the variable to hold the value of the barcode:
<variable name="vBarCode" datatype="STRING"
or_rfid_tag"/>
value="Root.Asset[0]['barcode_
d. Go to the <target_ci_type name="amAsset"> XML tag.
e. Below the tag, add the following XML tag:
<target_mapping name="BarCode" datatype="STRING" value="vBarCode"/>
f. Click OK.
3.
Add the BarCode to the am-push-mapping.xml configuration.
Note: This example is specific to Asset Manager version 9.3 and above.
a. Go to Data Flow Management > Adapter Management > Packages > AMPushAdapter >
Configuration Files > am-push-mapping.xml.
b. Go to the <am-mapping ci-type=”amComputer” from-version=”9.3”> XML tag.
c. Add the following rule to the advanced reconciliation rule:
<reconciliation-advanced> Portfolio.Asset.BarCode ='${if(vBarCode==null)
{ throw new
com.hp.ucmdb.adapters.ampush.exception.AMPushAdvancesReconciliationExcep
tion ('Not enough reconciliation data') }else{ return vBarCode}}
'</reconciliation-advanced>
This rule retrieves the computer whose asset has the same barCode value as vBarCode. If the
VBarCode is null, an exception is thrown stating that there is insufficient reconciliation data.
The exception thrown orders the AM Connector to try the next available reconciliation rule.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 108 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
d. To avoid overwriting an existing value, add the following to <am-mapping citype="amAsset">:
<attribute-reconciliation attribute-name="BarCode" updatescript="mappings.scripts.AMPushFunctions.fIsEmpty(vOldVal) ? vNewVal :
vOldVal"/>
e. Click OK.
How to Add a New Mapping to the Integration
This example shows how to add a new TQL query, push-mapping, and am-mapping to the integration. It
also shows how to push Locations from UCMDB to Asset Manager. It consists of the following steps:
Step 1: Create a TQL Query
1. Go to Modeling > Modeling Studio > New > Query.
2. From the CI Types tab, add a Location CIT to the query.
3. Right-click the Location Query Node and select Query Node Properties.
4. Rename the Element Name to Root.
5. Go to the Element Layout tab.
6. Select Select attributes for layout.
7. In the Attributes condition drop down, select Specific Attributes, and add the following attributes:
a. Name
b. LocationType
c. LocationBarCode
8. Click OK.
9. Save the query to Root > Integration > AM Push > AM Location Push.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 109 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
Step 2: Create a Push-Mapping
1. Go to Data Flow Management > Adapter Management > AMPushAdapter.
2. Click the
button and select New Configuration File.
3. Type the following Name: AMPushAdapter/mappings/hw/pushMappingAMLocation.xml.
4. Select the AMPushAdapter package.
5. Click OK.
6. Copy the following into the newly created XML file:
<integration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="/am-push-adapter/src/
main/resources/schema/am-push-adapter.xsd">
<info>
<source name="UCMDB" versions="10.0" vendor="HP"/>
<target name="AssetManager" versions="9.3" vendor="HP"/>
</info>
<import>
<!--Allows the XMLs to use the AMPushFunctions groovy methods-->
<scriptFile path="mappings.scripts.AMPushFunctions"/>
</import>
<targetcis>
<!--Query: Location(Root) -->
<source_instance_type query-name="AM Location Push" root-elementname="Root" >
<!-- Single_amLocation is the name we will refer to this CI in the
am-mapping.xml-->
<target_ci_type name="Single_amLocation">
<!--Retrieve the LocationBarCode from the Location CI and
place it in the amLocation record-->
<!—-‘name’ is the column name in Asset Manager’s table -->
<!—-‘datatype’ is the type of the data of this column -->
<!—-‘value’ the script to execute in order to retrieve the
value of this target_mapping-->
<target_mapping name="BarCode" datatype="STRING" value="Root
['location_bar_code']"/>
<target_mapping name="LocationType" datatype="STRING"
value="Root['location_type']"/>
<target_mapping name="Name" datatype="STRING" value="Root
['name']"/>
<!--Marks the location as created on the fly (So we can distinguish from AM
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 110 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
UI created Locations)-->
<target_mapping name="bCreatedOnTheFly" datatype="BOOLEAN"
value="1"/>
</target_ci_type>
</source_instance_type>
</targetcis>
</integration>
7. Click OK.
Step 3: Create an AM-Mapping
1. Go to Data Flow Management >Adapter Management > AMPushAdapter.
2. Click am-push-mapping.xml.
3. Insert the new mapping:
<!-- 'ci-type' is the name of the ci as appear in the mapping file.
'target-ci-type' the actual table name in Asset Manager
this target ci is mapped to -->
<am-mapping ci-type="Single_amLocation" primary-key="lLocaId"
target-ci-type="amLocation" operation-type="update_else_insert"
parallel-push-allowed="true" from-version="9.3">
<reconciliation>
<reconciliation-keys>
<!-- The reconciliation of 'location' will be done by the
two attributes: Name, LocationType.
Those are the two identifiers of Location CIT in UCMDB-->
<reconciliation-key>Name</reconciliation-key>
<reconciliation-key>LocationType</reconciliation-key>
</reconciliation-keys>
</reconciliation>
<!-- In case the CI has been deleted from the UCMDB,
it won't effect the amLocation in Asset Manager -->
<action-on-delete>
<ignore/>
</action-on-delete>
</am-mapping>
4. Click OK.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 111 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
Step 4: Create a Job with the New TQL Query
1. Go to Data Flow Management > Integration Studio.
2. Create an integration point with Asset Manager:
a. In the Integration Jobs tab, click the
button.
b. Insert a job name in the Name field.
c. Click the
button, and choose the AM Location Push query.
d. Click OK.
Step 5: Run the Job
1. Click on the job created in "Step 4: Create a Job with the New TQL Query".
2. Click the
button.
3. Wait for the job to finish. You should click the
button to see progress.
4. Make sure that the status is Succeeded.
Step 6: View the Results
1. Go to the Asset Manager Client.
2. Go to Organization Management > Organization > Location.
3. Validate that the Location pushed in the previous steps is displayed.
Frequently Asked Questions
What is a Root CI node?
A Root node is a TQL node that represents the CI type that is created via the push to Asset Manager
from the TQL Structures. Usually the rest of the TQL structure contains information that can be
incorporated within the Root CI type and is used to enrich the record in Asset Manager. The Root is the
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 112 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
heart of the Composite CI (or Instance), and if it is deleted from UCMDB we send a delete notification to
Asset Manager for the entire record.
When is a new Asset created in Asset Manager?
In the out of the box integration we create Assets for 4 types of UCMDB CIs:
l
Nodes
l
Business Elements
l
Printers
l
Display Monitors
Whenever UCMDB sends a CI of one of these types, the integration first tries to detect if this Asset
already exists in Asset Manager, using the defined reconciliation rules. If a matching Asset is found, it is
updated, otherwise a new Asset is created.
How do I control the action taken when a CI is deleted in UCMDB?
See "Action on Delete" on page 104.
I deleted a Node CI in UCMDB - Why isn’t it deleted in Asset Manager?
The default Action on Delete for nodes in the integration is to do nothing.
You may either change the action to delete the Asset in Asset Manager by changing the
<action-on-delete> xml mapping in the am-push-mapping.xml:
<am-mapping ci-type="amComputer" …>
…
…
<action-on-delete>
<delete-ci/>
</action-on-delete>
</am-mapping>
Or you may change the action to set the Asset as Missing in Asset Manager by changing the <action-ondelete> xml mapping in the am-push-mapping.xml:
<am-mapping ci-type="amComputer" …>
…
…
<action-on-delete>
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 113 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
<set-attribute-value name="Portfolio.seAssignment" datatype="INTEGER"
value="6"/>
</action-on-delete>
</am-mapping>
Validate that the Allow Delete check box in the job configuration is selected.
I deleted an Installed Software CI in UCMDB - Why isn’t it deleted in Asset Manager?
The default Action on delete for Installed Software in the integration is to mark it as missing.
You may change the action to delete the Soft Installed in Asset Manager, by changing the
<action-on-delete> xml mapping in the am-push-mapping.xml:
<am-mapping ci-type="Complete_amSoftInstall" …>
…
…
<action-on-delete>
<delete-ci/>
</action-on-delete>
</am-mapping>
Due to the complexity and amount of flows available for Installed Software you must also change these
mappings to match:
l
SW_amSoftInstall
l
Complete_amSoftInstall_User
l
soft_Hyper_amSoftInstall
l
SW_amSoftInstall_User
Is it possible to avoid overwriting an attribute in Asset Manager?
Yes. By using the Attribute Reconciliation feature, you choose to never overwrite an existing value.
Example:
<attribute-reconciliation attribute-name="AssetTag" update-script=
"mappings.scripts.AMPushFunctions.fIsEmpty(vOldVal) ? vNewVal : vOldVal"/>
See "Integration Architecture" on page 96.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 114 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
What is the different between the mapping XMLs and the am-push-mapping.xml?
The Mapping XMLs (for example: pushMappingAMBusinessElement.xml) define the way we convert the
data from the UCMDB data model into the Asset Manager Data Model and are executed by the Push
Adapter.
For more information, see Developing Push Adapters in the HP Universal CMDB Developer Reference
Guide.
The am-push-mapping.xml is the Asset Manager Connector configuration file. It configures the way we
reconcile and handle the data, before we update Asset Manager with the record.
Should I select the ‘Enable Parallel' Feature?
Asset Manager configured over an Oracle database supports parallel push out of the box.
Asset Manager configured over an SQL Server database, needs some tuning before enabling this
capability. See "Prepare Asset Manager for Parallel Push" on page 78.
Why does an integration point that synchronizes only the AM Installed Software
Push TQL query, keep failing?
The AM Installed Software Push TQL query contains both a query node of Installed Software and a query
node of Node. The Node in this mapping is only referenced, and is mapped to Asset Manager by saving
its Asset Manager ID from an earlier run. Before pushing this TQL query, the same integration point
must push the Node to Asset Manager (using the AM Computer Push TQL).
How can I push nodes without Model Name or Serial Number information, to Asset
Manager?
To avoid pushing nodes not yet fully discovered, we avoid sending ones without a Model Name or Serial
Number that provide us with a physical identification of the Asset. If you would like to push these nodes
as well, simply remove the appropriate condition of the node from the AM Computer Push TQL query.
However removing the Node Role condition (filtering nodes without a Node Role) from the TQL query is
not recommended, as the integration will not know what type of an Asset/Portfolio to create in Asset
Manager.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 115 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
Troubleshooting and Limitations
l
Limitation: A single probe may only connect to one version of Asset Manager. (Use of multiple
instances of the same version is supported). This is due to the JVM limitation of loading only one
Asset Manager API per process.
l
Limitation: The out of the box implementation does not support synchronization of mobile devices.
l
Limitation: The Data Flow Probe or Integration Service must be installed on a Windows OS.
l
Limitation: DB2 parallel push mode is not supported in UCMDB 10.01.
l
Problem: Missing DDLs or jars.
When testing the connection of the integration point, an error with the following phrase appears:
Asset Manager DLLs and/or Jars are missing
Solution: See "Create AMPushAdapterAPI Package with Required AM API Files" on page 80
l
Problem: First time synchronization has many failed CIs.
The first synchronization in the integration creates a large number of enum values in the Asset
Manager database. In some cases, when enabling the parallel push for the first synchronization, it
may cause a very large number of deadlocks during the push that is more than the Adapter’s auto
deadlock handling mechanism can handle.
Solution 1: You may try to re-synchronize the failed CIs until they all pass.
Solution 2: Add the enum attribute that caused the duplicate key exception to am-mapping in the
am-push-mapping.xml.
l
Problem: A push integration fails with the error message 'Only one connected Asset CI is
allowed'
When running a push integration of Computers to Asset Manager, one of the reconciliation
attributes used is Asset Tag. If there is more then one Asset CI connected to the Node CI, it means
there is more then one Asset Tag for a single Node; this is not a valid state.
Solution: Remove the CIT Computer from the incorrect Asset CIs. This should ensure the Node is
connected to either one or no Asset CIs.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 116 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
l
Problem: Some CIs in a Relations Push fail.
The Relations flow (TQL query) assumes that you schedule (either in the same job, or in a different
job) the different flows that this Relations push depends on, to run before this flow. The following
table shows the dependencies:
TQL Query
Depends On
AM Business Element
Push
AM Business Element
Relations Push
AM Business Element Push and AM Computer Push
Note: If the Asset Manager Business Element is not related to
computers, AM Business Element Relations Push does not
depend on AM Computer Push.
AM Computer Push
AM Computer Relations
Push
AM Computer Push
AM Host Server And
Running LPAR VM
Relations Push
AM Computer Push
AM Host Server And
Running Solaris VM
Relations Push
AM Computer Push
AM Host Server And
Running VM Relations
Push
AM Computer Push
AM Installed Software
Push
AM Computer Push
AM Net Device Relations AM Computer Push
Push
AM Oracle LMS Push
AM Computer Push
AM Software Hypervisor
Push
AM Computer Push
AM Software Solaris
Push
AM Computer Push
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 117 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
l
Problem: Some CIs in a Software Push fail.
The software flows assume that you schedule the computer push flow (either in the same job, or in a
different job) to run first. See "Why does an integration point that synchronizes only the AM Installed
Software Push TQL query, keep failing? " on page 115.
l
Problem: Missing Root in a TQL Query.
Solution: The integration TQL query must contain a Root Element (1 if it is a CI, 1 or more if it is a
Relationship). Update your TQL query by renaming one of the query Elements to Root. Make sure
your mapping xml is updated accordingly.
See "What is a Root CI node?" on page 112.
l
Problem: Error in Test Connection. Unable to connect to this database engine.
The following solution assumes you are connecting to a DB2 or Oracle database.
Solution: Validate the following:
1. The database client is installed on the Data Flow Probe/Integration Service machine. See "Install
a Database Client" on page 80.
2. The installed client is a 64 bit version.
3. The client is installed on the actual Probe selected in the integration point configuration.
l
Problem: Multiple Assets are created in Asset Manager for a single UCMDB Node.
Solution 1: This can happen when the maximum length of an attribute is too short compared to the
attribute's value in UCMDB. It causes the attribute value to truncate when pushed to Asset Manager.
However, on a different execution, when attempting to reconcile the attribute, there will not be a
match because of the truncated value in asset Manager. Therefore, increase the attribute length.
See "Update Asset Manager Schema" on page 77.
Solution 2: Check and fix customized or changed reconciliation rules.
l
Problem: Error in test connection: Module Ssl : Unable to load dynamic library (libeay64.dll).
This error occurs when the Windows operating system of the probe is missing the Visual C++ 2008
SP1 or later.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 118 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
Solution 1: Download and install the Microsoft Visual C++ 2008 SP1 Redistributable Package (x64).
You may download this from:
http://www.microsoft.com/download/en/details.aspx?id=2092.
Thereafter, reboot Windows and restart the Probe.
Solution 2: Run Windows update and retrieve the Visual C++ 2008 SP1 or later update. Thereafter,
reboot Windows and restart the Probe.
l
Problem: Reconciliation gaps when pushing and populating Business Elements using
reconciliation by Global-ID.
Solution: To populate Business Elements using reconciliation by Global-ID, complete the following:
a. Go to Dataflow Management > Adapter Managent > Packages and select AMPushAdapter.
b. Select Configuration Files > pushMappingAMBusinessElement.xml.
c. Replace the file content with the following:
<integration xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="/am-push-adapter/src/main/resources/schema/ampush-adapter.xsd">
<info>
<source name="UCMDB" versions="10.0" vendor="HP"/>
<target name="AssetManager" versions="9.3" vendor="HP"/>
</info>
<import>
<scriptFile path="mappings.scripts.AMPushFunctions"/>
</import>
<targetcis>
<!--Query: BusinessElement(root class = Business Service)(Root) -->
<source_instance_type query-name="AM Business Element Push*" root-elementname="Root" >
<target_ci_type name="IS_amAsset">
<variable name="globalId" datatype="STRING" value="Root['global_id']"/>
<variable name="vAssetTag" datatype="STRING"
value="AMPushFunctions.uCase(Root['name'])"/>
<target_mapping name="AssetTag" datatype="STRING" value="vAssetTag"/>
<target_mapping name="Label" datatype="STRING" value="Root['name']"/>
<target_ci_type name="IS_amPortfolio">
<target_mapping name="CMDBId" datatype="STRING" value="globalId"/>
<target_ci_type name="IS_amModel">
<target_mapping name="Name" datatype="STRING" value="Root['name']"/>
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 119 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
<target_ci_type name="IS_amNature">
<target_mapping name="Code" datatype="STRING" value="'BIZSVC'"/>
</target_ci_type>
<target_ci_type name="IS_amModel-Parent">
<target_mapping name="BarCode" datatype="STRING"
value="AMPushFunctions.getParentBarCodeFromType(Root['root_class'])"/>
</target_ci_type>
</target_ci_type>
</target_ci_type>
</target_ci_type>
</source_instance_type>
</targetcis>
</integration>
d. Click OK.
e. In the same directory select the am-push-mapping.xml file.
f. Delete the am-mapping of ci-type="IS_amAsset" and replace with the following:
<am-mapping ci-type="IS_amAsset" primary-key="lAstId" operation-type="update_
else_insert" target-ci-type="amAsset" merge-allowed="true" parallel-pushallowed="true"> <reconciliation>
<reconciliation-advanced>PortfolioItem.CMDBId = '${globalId}
'</reconciliation-advanced>
<reconciliation-keys>
<reconciliation-key ignore-case="true">AssetTag</reconciliation-key>
</reconciliation-keys>
</reconciliation>
<reference-attribute ci-name="IS_amPortfolio" datatype="STRING"
name="PortfolioItem" reference-direction="child"/>
<attribute-reconciliation attribute-name="AssetTag" updatescript="mappings.scripts.AMPushFunctions.fIsEmpty(vOldVal) ? vNewVal :
vOldVal"/>
<action-on-delete>
<delete-ci/>
</action-on-delete>
</am-mapping>
<am-mapping ci-type="IS_amPortfolio" primary-key="lPortfolioItemId" targetci-type="amPortfolio" operation-type="update_else_insert" parallel-pushallowed="true">
<reconciliation>
<follow-parent am-prefix="PortfolioItem"/>
</reconciliation>
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 120 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 3: HP Asset Manager Push Integration
<reference-attribute ci-name="IS_amModel" datatype="STRING" name="lModelId"
reference-direction="child"/> <action-on-delete>
<delete-ci/>
</action-on-delete>
</am-mapping>
g. Click OK.
o
Problem: The number of the virtual CPUs is pushed into AM
Some customers may tailor UD, add virtual CPUs as physical CPU CI, and then set the Is Virtual
attribute to True. In this situation, the push adapter will count the number of both virtual and
physical CPUs to set the fCPUNumber field in AM.
Solution 1: To avoid counting virtual CPU in AM, add the Is Virtual = False condition in AM
Computer/Node Push TQL.
Solution 2: Create a groovy function (for example, getPhysicalCoreCount) to count the CPU CIs
whose Is Virtual is False.
Logs
The push adapter framework uses a different logs then the normal fcmdb.adapters.*.log files.
To change the level of the log files to debug, edit the following file:
l
On the Data Flow Probe machine:
..\DataFlowProbe\conf\log\fcmdb.push.properties
l
If using the integration service, on the UCMDB server:
..\UCMDB Server\Integrations\conf\log\fcmdb.push.properties
Change the log level to DEBUG:
loglevel=DEBUG
The integration generates fcmdb.push.* logs in the following folder:
l
On the Data Flow Probe machine:
..\DataFlowProbe\runtime\log\
l
If using the integration service, on the UCMDB server:
..\UCMDB Server\Integrations\runtime\log\
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 121 of 366
Chapter 4: HP Asset Manager Integration with
the AM Generic Adapter
This chapter includes:
Overview
123
Supported Versions
124
Architecture
124
How to Integrate UCMDB and Asset Manager
125
HP Asset Manager Setup
125
HP UCMDB Setup
130
Out-of-Box Integration Jobs
134
Verify Out-of-Box Population and Push Jobs
144
Integration Jobs Configuration
149
Standards and Concepts
152
Asset Manager Entity
152
UCMDB TQL
157
Groovy Functions
158
Data Mapping Schema
164
Population and Federation
166
Push and Reconciliation
172
Deletion
181
Installed Software / Software Utilization
184
Mapping UI
186
How to Tailor the Integration
189
How to Change Adapter Settings
189
How to Customize an Existing Mapping
191
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 122 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
How to Add a New Mapping to the Integration
195
How to Populate Asset Manager Contract
197
How to Set up Federation
204
How to Set up Integration in a Multi-Tenant Environment
205
Performance Tuning and Best Practice
211
Chunk Size
211
Time out
211
TQL Tailoring
212
Push Mapping Simplification
212
Global ID
213
Population Mapping Optimization
214
Migration Guide
214
Differences between Old Push Adapter and Push in Generic Adapter
214
Differences between Old Population Adapter and Population in AM Generic Adapter
216
Frequently Asked Questions
217
Troubleshooting and Limitations
221
Logs
224
AM API Logs
224
Overview
Integration between HP Universal CMDB (UCMDB) and HP Asset Manager enables you to share
information between UCMDB and Asset Manager. Common use cases include pulling asset from Asset
Manager and pushing inventory CIs like hardware, installed software, and business services from UCMDB
to Asset Manager.
You can use the integration to automate the creation and update of Asset and Portfolio information in
Asset Manager through data push. This ensures that Asset Manager is kept up-to-date with real,
accurate, and discovered data in your environment. On the other hand, it automates the creation and
update of Node and Asset information in UCMDB by populating asset data from Asset Manager to
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 123 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
UCMDB. It takes advantage of the built-in procurement and retirement processes of Asset Manager to
enable UCMDB to manage IT assets which are not in operation and are undiscoverable.
Note: This Integration replaces the Connect-It Scenarios used for synchronizing hardware and
software information from DDMI 9.3x (and earlier versions) to Asset Manager. Also, this integration
replaces the Connect-It Scenarios used for synchronizing Business Services and Business
Applications from UCMDB to Asset Manager.
When referring to the concept of data information, it is important to distinguish between a UCMDB CI
(Configuration Item) and an Asset Manager Asset. Both are defined in a different Data Model, and there
must be a conversion before transferring CIs in UCMDB to Assets in Asset Manager and vice versa.
Supported Versions
This integration supports HP Asset Manager 9.41 and later versions.
Architecture
Asset Manager Generic Adapter is a new version of the AM adapter for exchanging data between Asset
Manager and UCMDB. It bundles 3 core features of the AM and UCMDB integration in a single adapter:
population, federation, and push. The AM Generic Adapter is built on top of the Generic Adapter (GA),
which is a unified framework for external systems to integrate with UCMDB. The GA framework provides
a graphic user interface for integration developers and administrators to ease the creation and
customization of data mapping files. In the graphic mapping UI , you can easily map attributes and
relationships between AM Entity and UCMDB CI.
AM Entity is a new layer introduced in the AM Generic Adapter. For more information, see "Asset
Manager Entity" on page 152.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 124 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Population and Federation
The AM Generic Adapter retrieves data from the AM database through the AM native APIs and creates
AM entity objects with regards to the AM entity structure defined in am-entity-config.xml. Conditions
specified in the file am-populate-config.xml filter the data retrieved from AM for a given entity.
The AM entity objects are converted to UCMDB CI structure according to the mapping script defined in
mapping files. The Generic Adapter framework transits the mapped CIs to the UCMDB Data In engine for
processing.
Push
UCMDB stores its information using CIs. The integration chooses which data to be pulled from UCMDB by
defining integration TQL queries. Each TQL query defines a superset of data relevant for the integration.
The UCMDB Push Engine:
l
Retrieves the required data from UCMDB, using the given TQL query.
l
Filters the data to include only the data that has changed since the last execution of this
synchronization.
l
Splits the data into multiple chunks without breaking consistency.
l
Sends the information to the Probe/Adapter.
The Generic Adapter framework allows easy mapping of the data from the UCMDB data model into the
Asset Manager Data Model. It also allows transfer of this converted data into the AM Generic Adapter.
The AM Generic Adapter connects to the AM database through the AM native APIs to reconcile, push, and
handle the complex logic needed to synchronize data into Asset Manager.
How to Integrate UCMDB and Asset Manager
This section describes how to integrate UCMDB and Asset Manager.
HP Asset Manager Setup
To set up Asset Manager for the integration, following the steps described in this section.
Validate Pre-Loaded Data in Asset Manager
For the integration to succeed, some basic data is required to exist in the Asset Manager database.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 125 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
This data may either be imported during the database creation (using the Asset Manager Application
Designer), or may be added later. For more information, see the Asset Manager Documentation –
Administration.
For hardware synchronization the required data is:
l
Shared Data
l
UNSPSC Product Classification
l
Portfolio – Line-of-business data
l
Virtualization – Line-of-business data
l
Business services management – Line-of-business data
For software synchronization the required data is:
l
Software Asset Management – Line-of-business data
Create an Account with Administrative Rights
For the integration, any user with administrative rights will suffice. Asset Manager OOTB installations
include an administrator account.
The details of the default Administrator user are:
l
User: Admin
l
Password: <empty>
The following example shows how to create a new user (named Integration-Admin) with administration
rights, specifically for the integration.
1. Log on to Asset Manager as the Administrator.
2. Go to Organization Management > User actions > Add a user.
a. In ID #, type: Integration-Admin.
b. In Name, type: Integration-Admin.
c. In First, type: Integration-Admin.
d. Click Next.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 126 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
e. Click Next.
f. Click Finish.
3. Go to Organization Management > Organization > Employees.
4. Select the newly created user and click the Profile tab.
5. In User name, type: Integration-Admin.
6. In Password, type: <A password you would like to use>.
7. In the Password Administration pane, ensure that Never Expires is selected.
8. In the Profile pane, ensure Administration rights is selected.
9. Click Modify.
Update Asset Manager Schema
By default, the Asset Manager database schema includes column lengths that may be significantly
shorter than their counterparts in the UCMDB database schema. For attributes used for reconciliation,
this may be critical and may cause creation of multiple records.
To fix this issue, we recommend that you change the Asset Manager Column Sizes to the values shown
in the following table of Asset Manager attributes.
Table
Name
Default Max Length
New Value
amAsset
SerialNo
128
250
amModel
Name
128
250
amSoftInstall
Field1
26
255
amBrand
Name
128
250
amEmplDept
UserName
128
200
amEmplDept
UserDomain
128
200
Note: The new values in the table are only a suggestion, and you may need to change them
according to actual data per customer use case.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 127 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Note: For DB2, the default table space page size of 4K may be too small in some cases. We
recommend that you use 8K or higher larger.
Activate Workflows for Population
In Asset Manager, the amComputer is an overflow table to the amPortfolio table. Part of its attributes
are stored in the amPortfolio table. For instance, seAssignment. Some other attributes are distributed
to other tables, such as amAsset. By default, if you make changes to any other tables than
amComputer, its Last Modified Time does not change. As a result, when you run a delta sync on a job to
populate Node, the changes will not be captured. To solve this problem, you need to activate two
workflows in Asset Manager. To do this, follow these steps.
1. Log on to the Asset Manager client.
2. On the Tools menu, point to Workflow, click Workflow schemes.
3. Locate the Update dtRecCreation (SQL name: sysCoreUpCrTime) workflow and the Update last
modify time (SQL name: sysCoreUpMdifyTime) workflow.
4. On the General tab, empty the End field of the Validity pane.
5. Save the changes.
Prepare Asset Manager for Parallel Push
Enabling Parallel Push significantly improves the performance of the push. However, some advanced
preparations are necessary. Different actions are needed for different database types, as shown in the
following table.
Database
Action
DB2
Mandatory: Follow Eliminating locks and deadlocks in the Asset Manager Tuning Guide.
Oracle
Optional: Follow Eliminating locks and deadlocks in the Asset Manager Tuning Guide.
SQL Server
Mandatory: Follow the steps below.
Mandatory steps for SQL Server
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 128 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
1. Alter the SQLServer Schema isolation level. To do this, execute the following command on the
database, replacing <AMSchema> with the real schema name.
ALTER DATABASE <AMSchema> SET READ_COMMITTED_SNAPSHOT ON
ALTER DATABASE <AMSchema> SET ALLOW_SNAPSHOT_ISOLATION ON
GO
Note: If the execution takes too long, you may need to disconnect all connections to the
database. One possible way is to restart the database service, then execute the command. If
you restart SQL Server and an Integration Point has already been created in UCMDB, you
should restart the UCMDB Probe as well to avoid the issue of dead connections.
2. Alter Asset Manager database options:
a. Open the Asset Manager client and connect to the appropriate database schema.
b. Navigate on the top menus to Administration > Database options.
c. For the option Sql Server specifics’|‘Isolation command before starting a write transaction,
change the current value to set transaction isolation level snapshot.
3. Create a table for each of the following counters.
To do this, follow the instructions in the Eliminating locks and deadlocks chapter of the Asset
Manager Tuning Guide.
o
amAsset_AssetTag
o
amBrand_BarCode
o
amModel_BarCode
o
amModel_ModelRef
o
amAssignment_Code
o
amEmplDept_BarCode
o
amComputer_Group
o
amComputer_Domain
o
amComputer_Vm
o
amComputer_MD
o
amComputer_Name
o
amSoftInstall_Code
o
amMonitor_Serial
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 129 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Create Asset Manager API Zip Package
In order for the adapter to connect to the appropriate Asset Manager version, you must supply the Data
Flow Probe/Integration Service with the appropriate Asset Manager API DLLs and Jars. To do this, follow
these steps.
1. Copy the files below:
o
<Asset Manager Installation folder>\x64\*.dll
o
<Asset Manager Installation folder>\websvc\lib\*.jar
2. Create a package named AMGenericAdapterAPI_<AM Version Number>.zip. For example, for
version 9.41 the package name is AMGenericAdapterAPI_9.41.zip.
3. Paste the copied files to:
AMGenericAdapterAPI_<AM Version
Number>.zip\discoveryResources\AMGenericAdapter\amVersion\<AM Version Number>
For example, for version 9.41, the path is:
AMGenericAdapterAPI_9.41.zip\discoveryResources\AMGenericAdapter\amVersion\9.41
HP UCMDB Setup
To set up UCMDB for the integration, follow the steps detailed in this section.
Deploy Asset Manager API Zip Package
1. In the UCMDB client, go to Administration > Package Manager.
2. Deploy the AMGenericAdapterAPI_<AM Version Number>.zip package you created.
Install a Database Client
You must install the database client software according to the type of database the Asset Manager
schema is installed on, as detailed in the following table.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 130 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Database Client Software
SQL
None required.
Server
DB2
1. Download and Install “IBM Data Server Client” 64 bit for windows on your Data Flow
Probe/Integration Service computer. This may be downloaded from:
http://www-01.ibm.com/support/docview.wss?rs=4020&uid=swg21385217
2. Create a connection to the DB2 database of Asset Manager.
You may create this using the DB2 Control Center.
Note: Remember the Database Alias you define in the connection, because you
need it when creating the integration point.
3. Copy the db2cli64.dll file from the DB2 client bin directory (By default: C:\Program
Files\IBM\SQLLIB\BIN) to the <Data Flow Probe/Integration Service>\lib folder.
4. Restart the Data Flow Probe/Integration Service.
Oracle
Oracle client windows 64 bit
For example: Oracle Database 11g Release 2 Client (11.2.0.1.0) for Microsoft Windows
(x64).
1. Download the client installation from:
http://www.oracle.com/technetwork/database/enterpriseedition/downloads/index.html
2. Install the client, in Administrator mode, on the Data Flow Probe/Integration Service
computer.
3. Copy oci.dll from the <Oracle Client installation directory> into:
<Probe/Integration Service installation directory>\lib.
4. Restart the Data Flow Probe/Integration Service.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 131 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Create an Integration Point in UCMDB
1. Log on to UCMDB as an administrator.
2. Go to Data Flow Management > Integration Studio. UCMDB displays a list of existing integration
points.
3. Click the
button. The New Integration Point dialog box is displayed.
4. Complete the Integration and Adapter Properties fields as shown in the following table:
Field
Required Description
Integration
Yes
Type the name (unique key) of the integration point.
No
Type a description of the current integration point.
Adapter
Yes
Select HP Software Products > Asset Manager > Asset Manager
Generic Adapter
Is
Yes
Select this option to indicate the integration point is active.
Hostname/IP
Yes
Type the hostname or IP Address of the Asset Manager database.
DB Type
Yes
Select the database type your Asset Manager schema is located on.
DB Port
Yes
Type the communication port of the Asset Manager Data Base.
Name
Integration
Description
Integration
Activated
DB Name/SID Yes
o
DB2: type in the name of the Database Alias you defined in the
database connection.
DB Owner
Yes
o
Oracle: type the service name.
o
SQL Server: type the name of the schema.
Enter the owner of the AM database schema.
Name
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 132 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Field
Required Description
Credentials
Yes
Select Asset Manager Protocol. To create a new protocol, click the
ID
AM Version
button. Under Asset Manager Protocol complete:
Yes
o
Asset Manager User Name: An AM administrator's user name.
o
Asset Manager Password: An AM administrator's password.
o
DB User Name: The AM database user's name.
o
DB Password: The AM database user's password.
Select the version of Asset Manager this integration point is to
connect to.
AM
No
Population
Select True to allow the adapter to push the Global Id of UCMDB CI
back to the corresponding AM entity.
Push Back ID
AM Other
No
Options can be used in the amdb.ini file. See Asset Manager
Connection
Installation Guide, Chapter .ini, .cfg, and .res files > Amdb.ini File
Options
Entries.
Enable
No
Parallel Push
Select to allow parallel (multi-threaded) data push to Asset Manager.
This improves performance. Note that you must configure SQL Server
& DB2 to support parallel push. See "Prepare Asset Manager for
Parallel Push".
Data Flow
Yes
Probe
Additional
Probes
Select the name of the Data Flow Probe/Integration service used to
execute the synchronization from.
No
Select additional probes to use when pushing to AM in order to
increase redundancy.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 133 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Field
Required Description
Default
No
owner name
The name of the owner tenant that should be assigned to the
federated or populated CIs and relationships.
This field does not take effect for push operations.
Note:
o
This field is displayed when creating a federation or population
type integration point in a multi-tenancy environment only.
o
If no owner tenant is specified, but the Data Flow Probe selected
for the integration point has an owner tenant, then the Data Flow
Probe owner tenant is assigned to all discovered CIs.
o
The System Owner Tenant is assigned when:
l
No owner tenant is specified, and no owner tenant is defined
onthe Data Flow Probe.
l
o
The data source is not a multi-tenancy environment.
This field only appears in a Multi-Tenant Enabled UCMDB.
5. Click Test Connection to make sure there is a valid connection.
6. Click OK.
The integration point is created and its detailed are displayed.
UCMDB creates a default data push job when creating the integration point. If needed you may
create or edit the existing job. For more information, see "Work with Data Push Jobs" in the HP
Universal CMDB Data Flow Management Guide.
Out-of-Box Integration Jobs
AM Generic Adapter is shipped with out-of-box jobs for population and push between Asset Manager
and UCMDB. Integration job is driven by UCMDB TQLs.
To access these TQLs, follow these steps.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 134 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
1. Log on to UCMDB as an administrator.
2. Go to Modeling > Modeling Studio > Resources, and then select Queries from the Resource Type
drop-down list.
3. Expand Root/Integration/AMGenericAdapter. There are 3 sub folders: federation, population and
push.
o
All queries under the federation folder federate CI data from AM to UCMDB.
o
All queries under the population folder manage CI data synchronization from AM to UCMDB.
o
All queries under the push folder manage CI data synchronization from UCMDB to AM.
Asset Manager Population Jobs
In the following table, all TQLs which are included in the default population job are listed. For each TQL
query, it describes the source AM entity type and the target CI types converted by the out-of-box
mapping XMLs. In the description column, it contains a summary of the TQL query, the out-of-box
mapping XML to convert the data, and the other data populations it depends on, which need to be run
beforehand.
TQL Query
AM Entity
UCMDB CI Type
Description
AM Location Population
Location
Location
Populates location.
2.0
l
Location
Mapping XML:
AM Location Population.xml
AM Node Population 2.0
ITEquipment
Node
l
Location
Populates Node with Asset and
Location.
Mapping XML:
l
AM Interface Population NetworkCard
Asset
Interface
2.0
l
Node
AM Node Population.xml
Populates Interface with IpAddress
and Node relations.
Depends On:
l
IpAddress
AM Node Population 2.0
Mapping XML:
AM Interface Population.xml
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 135 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
TQL Query
AM Entity
UCMDB CI Type
Description
AM BusinessElement
Asset
BusinessElement
Populate Business Element with
Population 2.0
l
Asset
Asset.
Mapping XML:
AM BusinessElement
Population.xml
AM BusinessElement
Client_
Relations Population
Resource_
2.0
Relationship
BusinessElement
Populate Business Element
relationship with Business Element
l
BusinessElemen
t
l
Node
and Node.
Depends On:
l
AM Node Population 2.0
l
AM BusinessElement
Population 2.0
Mapping XML:
AM BusinessElement Relations
Population.xml
AM Printer Population
Portfolio_
2.0
Printer
Printer
l
Node
Populates Printer with the relation
to Node.
Depends On:
AM Node Population 2.0
Mapping XML:
AM Printer Population.xml
Asset Manager Push Jobs
The below table lists all TQLs for data push contained in the out-of-box AM Generic Adapter. Some of
them are included in the default push job. For each TQL query, it describes the source CI type and the
target AM Entity type converted by the out-of-box mapping XMLs. In the description column, it contains
a summary of the TQL query, the out of the box mapping XML to convert the data, and the other data
pushes it depends on, which need to be run beforehand.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 136 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
TQL Query
AM Entity
UCMDB CI Type
Description
AM Node Push
ITEquipment
Node
Pushes nodes (Computers,
2.0
l
PhysicalDrives
l
Asset
l
NetworkCards
l
CPU
Network Devices, etc.). Also
pushes IPs, Interfaces, Disk
Devices, Physical Ports,
Hardware Boards, Display
l
LogicalDrives
l
FileSystem
l
ExtensionCards
l
LogicalVolume
l
HardwareBoard
l
DisplayMonitor
l
DiskDevice
AddOn (Printer,
Monitor)
Monitors, CPUs, Printers,
Inventory Scanners, File
Systems, and Assets.
Minimal attributes for pushing a
Node:
l
Serial Number
l
Vendor or Discovered
l
InventoryScanner
l
IpAddress
l
Model or Discovered Model
l
Virtual Host
l
Node Role
Vendor
Resource
l
PhysicalPort
Note: These are required
values, and depend on the
l
AM Business
Asset
VMWare Host
capability of the data
Resource
source to report them.
l
Printer
Mapping XML:
l
Interface
AM Node Push.xml
BusinessElement
Element Push 2.0
Pushes Business Applications,
Business Services and Business
Infrastructure CIs.
Mapping XML:
AM BusinessElement Push.xml
AM Business
Client_Resource_
Element
Relationship
Relations Push
2.0
HP Universal CMDB (Content Pack 17.00 (CP17))
BusinessElement
l
BusinessElement
l
Node
Pushes relationships between
Business Elements (pushed by
AM Business Element Push
Query) to other business
Page 137 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
TQL Query
AM Entity
UCMDB CI Type
Description
elements or to nodes.
Depends On:
l
AM Business Element Push
2.0
l
AM Node Push 2.0
Note: If the Asset Manager
Business Element is not
related to computers, AM
Business Element Relations
Push does not depend on
AM Computer Push.
Mapping XML:
AM BE Relations Push.xml
AM Host Server
Client_Resource_
And Running VM
Relationship
Node
l
Relations Push
Node
2.0
Pushes relations between Host
and Guest (Virtualized)
operating systems.
Depends On:
AM Node Push 2.0
Mapping XML:
AM Host VM Relations Push.xml
AM Host Server
Client_Resource_
And Running
Relationship
Solaris VM
Unix
l
Unix
Pushes relations between
Solaris Host and Guest
(Virtualized) operating systems.
Relations Push
2.0
Depends On:
AM Node Push 2.0
Mapping XML:
AM Host VM Solaris Relations
Push.xml
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 138 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
TQL Query
AM Entity
UCMDB CI Type
Description
AM Host Server
Client_Resource_
Unix
Pushes relations between Host
And Running
Relationship
l
LPAR VM
Unix
Relations Push
and Guest (virtualized) systems
of LPAR type.
Depends On:
2.0
AM Node Push 2.0
Mapping XML:
AM Host VM Lpar Relations
Push.xml
AM Computer
Client_Resource_
Relations Push
Relationship
Node
l
2.0
Node
Pushes relations between
Computers to any node
(Computers, Network Devices,
etc.).
Depends On:
AM Node Push 2.0
Mapping XML:
AM Computer Relations
Push.xml
AM Net Device
Client_Resource_
Relations Push
Relationship
Node
l
2.0
Node
Pushes relations between
Network Devices and Network
Devices.
Depends On:
AM Node Push 2.0
Mapping XML:
AM NetDevice Relations
Push.xml
AM Installed
SoftwareInstallation
InstalledSoftware
Software Push
2.0
l
Node
l
InventoryScanner
Pushes Installed Software CIs.
These Installed Software CIs will
be normalized in AM after push.
Depends On:
AM Node Push 2.0
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 139 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
TQL Query
AM Entity
UCMDB CI Type
Description
Mapping XML:
AM InstalledSoftware Normalize
Push.xml
AM Software
SoftwareInstallation
UserSoftwareUtilization Pushes Software Utilization CIs.
Utilization Push
These Software Utilization CIs
2.0
will be normalized in AM after
l
Node
l
InventoryScanner
Depends On:
l
InstalledSoftware
AM Node Push 2.0
push.
Mapping XML:
AM UserSoftwareUtilization
Normalize Push.xml
AM Installed
SoftwareInstallation
InstalledSoftware
Software
Normalized Push
2.0
l
Node
l
InventoryScanner
Pushes Installed Software CIs.
These Installed Software CIs
should already be recognized by
normalization technology in
UCMDB, for example, BDNA.
They will not be normalized in
AM after push.
Depends On:
AM Node Push 2.0
Mapping XML:
AM InstalledSoftware Nonnormalize Push.xml
AM Software
SoftwareInstallation
UserSoftwareUtilization Pushes User_Software_
Utilization
Utilization CIs. These Installed
Normalized Push
2.0
l
Node
l
InventoryScanner
Software CIs should already be
recognized by normalization
technology in UCMDB, for
example, BDNA. They will not be
l
HP Universal CMDB (Content Pack 17.00 (CP17))
InstalledSoftware
normalized in AM after push.
Page 140 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
TQL Query
AM Entity
UCMDB CI Type
Description
Depends On:
AM Node Push 2.0
Mapping XML:
AM UserSoftwareUtilization
Non-normalize Push.xml
AM Software
SoftwareInstallation
Hypervisor
Hypervisor Push
l
2.0
Node
Pushes Hypervisor Installed
Software.
Depends On:
AM Node Push 2.0
Mapping XML:
AM Hypervisor Push.xml
AM Software
SoftwareInstallation
Unix
Solaris Push 2.0
l
Unix
Pushes Solaris Installed
Software.
Depends On:
AM Node Push 2.0
Mapping XML:
AM Solaris Zone Push.xml
AM Oracle LMS
MonitoredApplication Oracle
Push 2.0
Pushes the Oracle Running
Software and its Oracle LMS
l
Node
l
InstalledSoftware
Depends On:
l
AuditDocuement
AM Node Push 2.0
data.
Mapping XML:
AM Oracle LMS Push.xml
AM Cluster Push
Cluster
Cluster
2.0
l
Asset
Pushes Cluster CIs. It is not
included in the default push job.
Mapping XML:
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 141 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
TQL Query
AM Entity
UCMDB CI Type
Description
AM Cluster Push.xml
AM Cluster Node
Cluster_Component_
Relations Push
Relationship
Cluster
l
2.0
Node
Pushes cluster relations
between Computer Elements
and Cluster.
Depends On:
AM Node Push 2.0 AM Cluster
Push 2.0
Mapping XML:
AM Cluster Node Relations
Push.xml
AM Cluster
MonitoredApplication Runningsoftware
Runningsoftware
Push 2.0
l
Node
l
Cluster
Pushes Cluster
Runningsoftware CIs. By
default, it is not included in the
push job.
Depends On:
l
AM Node Push 2.0
l
AM Cluster Push 2.0
Mapping XML:
AM Cluster RunningSoftware
Push.xml
AM Cluster
Cluster_Component_
Runningsoftware
Relationship
Relations Push
2.0
Cluster
l
Runningsoftware
Pushes cluster
RunningSoftware relations
between Computer Elements
and Cluster. By default, it is not
included in the push job.
Depends On:
AM Cluster Push 2.0
AM Cluster Runningsoftware
Push 2.0
Mapping XML:
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 142 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
TQL Query
AM Entity
UCMDB CI Type
Description
AM Cluster RunningSoftware
Relations Push.xml
Asset Manager Federation Configuration
By default, the following supported and selected CI types can be federated from Asset Manager:
l
Node
l
CPU
l
DiskDevice
l
FileSystem
l
InstalledSoftware
l
LogicalVolume
l
Printer
The following table lists all TQLs for the data federation that are contained in the out-of-box AM Generic
Adapter. For each TQL query, it describes the source AM Entity type and the target CI type converted by
the out-of-box mapping XMLs.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 143 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
TQL Query
AM Entity
UCMDB CI Type
Mapping XML
AM Federation cpu_12 2.0
ITEquipment
CPU
AM Cpu Federation.xml
AM Federation cpu_node
ITEquipment
CPU
AM Cpu Node Relations
2.0
l
AM Federation disk_
Node
Federation.xml
PhysicalDrive
DiskDevice
AM DiskDevice Federtion.xml
PhysicalDrive
DiskDevice
AM DiskDevice Node
device_12 2.0
AM Federation disk_
device_node 2.0
l
AM Federation file_
Node
Relations Federtion.xml
LogicalDrive
FileSystem
AM FileSystem Federtion.xml
LogicalDrive
FileSystem
AM FileSystem Node
system_12 2.0
AM Federation file_
system_node 2.0
l
AM Federation installed_
Node
SoftwareInstallation InstalledSoftware
software_12 2.0
AM Federation installed_
SoftwareInstallation InstalledSoftware
l
LogicalDrive
Node
LogicalVolume
volume_12 2.0
AM Federation logical_
AM InstalledSoftware Node
Relations Federtion.xml
AM LogicalVolume
Federtion.xml
LogicalDrive
LogicalVolume
volume_node 2.0
l
AM Federation printer_12
AM InstalledSoftware
Federtion.xml
software_node 2.0
AM Federation logical_
Relations Federtion.xml
Node
AM LogicalVolume Node
Relations Federtion.xml
Portfolio_Printer
Printer
AM Printer Federtion.xml
Portfolio_Printer
Printer
AM Printer Node Relations
2.0
AM Federation printer_
node 2.0
l
Node
Federtion.xml
Verify Out-of-Box Population and Push Jobs
This section describes how to verify out-of-box population and push jobs.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 144 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Synchronize Data between UCMDB and Asset Manager
The AM Generic Adapter provides two types of jobs:
l
Data push jobs copy CI or CI relationship records from your UCMDB system to your Asset Manager
system.
l
Data population jobs copy Asset or Asset relationship records from your Asset Manager system to
your UCMDB system.
To run a data push/population job, follow these steps:
1. Log on to UCMDB as an administrator.
2. Go to Data Flow Management > Integration Studio. UCMDB displays a list of existing integration
points.
3. Select the integration point you created for Asset Manager.
4. Add a new data push/population job as follows:
a. Click the
button on the right panel.
b. In the Name field, type a unique name for the job.
c. Click the
button to add existing TQL queries to the job.
d. For push jobs, select or unselect the Allow Deletion option for each query. (The setting
determines if this TQL query is allowed to delete data from Asset Manager, though the actual
action on delete is defined by CI type in the mapping xml.)
For population jobs, select the Allow Integration Job to Delete Removed Data according to
the requirement. (The setting determines if the population job is allowed to delete CIs from
UCMDB.)
e. Click OK.
f. Save the integration point.
5. Manually run the job to see if the integration job works properly:
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 145 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
a. To push/populate all the relevant data for the job, click the
button.
b. To push/populate only the changes in the data since the job last executed, click the
6. Wait for the job to complete, click the
button.
button multiple times as needed until the job is
completed.
7. When the job is completed, the job status becomes one of the following depending on the results:
o
Succeeded
o
Completed
o
Failed
8. Click the Statistics tab to view the results. If any errors occur, click the Query Status tab and Job
Errors tab for more information. For more information about errors, see "Troubleshooting and
Limitations".
Note: For details about these tabs and managing the integration, see Integration Jobs Pane in
the HP Universal CMDB Data Flow Management Guide.
If the job completes successfully, you can view the UCMDB CI data in Asset Manager.
How to View UCMDB Data in Asset Manager
After a push job is successfully completed, you can search for and verify that the pushed CI/relationship
data is in Asset Manager.
Nodes
This includes computers, network devices, and so on.
To view the nodes:
1. Log on to Asset Manager as an administrator.
2. Go to Portfolio Management > Asset Configurations > IT equipment > Computers and virtual
machines.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 146 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
3. In the opened dialog box, for IP name, type the name of the computer you are searching for.
4. You may use ‘<name prefix>%’ for easier searching. For example, searching IP name for mycomp%
returns computer mycomp1, mycomp2, and so on.
5. Browse the computer for the different data.
Business Elements
This includes Business Applications, Business Services and Business Infrastructures.
1. Log on to Asset Manager as an administrator.
2. Go to Asset Lifecycle > IT Services and virtualization > Business services > Business services.
3. Browse the different Services.
For more information about viewing data in Asset Manager, see the Asset Manager Documentation.
How to View Asset Manager Data in UCMDB
After a population job is successfully completed, you can search for and verify that the populated Asset
data is in UCMDB. To do this, follow these steps.
1. Log on to UCMDB.
2. Go to Modeling > IT Universe Manager.
3. Click the Search CIs tab and search for the name of the Asset populated from Asset Manager.
How to Federate Asset Manager Data in UCMDB
After Integration point of AM Generic Adapter is created and activated, you will find the supported CI
types in the Federation page.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 147 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
To federate these supported CI in UCMDB, you can create a query in UCMDB client > Modeling
>Modeling Studio > Resources. Then, add a supported CI to federate data from AM. For example:
Printer.
Click the CI icon, and then find Data Sources tab from the following area.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 148 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Edit Data Sources, select integration points from the following options, and then select integration
points, for example, AMGA941.
Verify Calculate Query Result Count or Preview, you can federate those printers from AM server.
Integration Jobs Configuration
This section describes the configurations to be made to the integration jobs.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 149 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
How to Schedule Data Integration Jobs
UCMDB allows you to schedule job executions directly from integration jobs. To do this, follow these
steps:
1. Log on to UCMDB as an administrator.
2. Go to Data Flow Management > Integration Studio. UCMDB displays a list of existing integration
points.
3. Select the integration point you created for the UCMDB - AM integration.
4. Select the push job.
5. Click the
button.
Note: UCMDB allows you to define two different schedules for two types of data push:
Changes Synchronization and All Data Synchronization. We recommend that you use the
Changes Sync schedule to only synchronize changes and avoid synchronizing the entire set of
data each time.
6. Define a schedule for Changes Sync.
a. Click on the Changes Synchronization tab.
b. Select the Scheduler enabled option.
c. Select the scheduling options you want to use.
7. Click the All Data Synchronization tab and select the scheduling options you want to use.
8. Click OK.
9. Save the integration point.
Edit Data Integration Jobs
When you create an AM Generic Adapter integration point, a default job is created for data population
and data push respectively. You can perform the following actions in the jobs.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 150 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
l
Add or remove TQLs.
l
Clear cache
l
Show Results For Job
(available only for population jobs)
(available only for population jobs)
Query Status
l
Push selected failed data
l
Suppress selected failures/warnings
l
Up One Level/Down One Level
l
View details
Job Definition
l
Allow Integration Job to delete removed data
l
Add/Delete
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 151 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
l
Move Query Up/Move Query Down
l
Edit Query Resources
Standards and Concepts
This section describes standards and concepts.
Asset Manager Entity
The AM Generic Adapter introduces a new concept named AM Entity. The AM Entity is a type of object
that represents a collection of attributes abstracted from an AM table. All entities defined in the AM
Generic Adapter make up the AM Class Model which represents the subset of AM objects that can be
used in the population, push, as well as the graphic mapping UI. With the introduction of the AM Class
Model (i.e. Entity) as an additional layer on top of AM database API, population and push mappings do
not need to directly specify exact AM database tables or views. Extending AM Class Model is as simple as
defining new entities by editing the am-entity-config.xml file. The entity name can be customized to a
value that best fits your preference.
The entity is used mainly in the following places.
l
It is displayed in the external class model pane on the mapping UI.
l
It is referenced in mapping scripts.
l
It is used in am-populate-config.xml for configuring initial AQL (AM Advanced Query Language)
conditions to produce data from AM (used by population and federation).
l
It is used in am-push-config.xml for reconciliation rule definition (used by push).
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 152 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Asset Manager Entity Definition Steps
The AM entity definition steps are as follows.
1. Import AM tables.
2. Create a new AM entity based on an imported AM table.
3. Define the entity's attributes and links to be used in the AM Generic Adapter.
The definition of the entities is saved in the am-entity-config.xml file. To access the file, go to Data
Flow Management > Adapter Management > Packages > AMGenericAdapter > Configuration Files.
The am-entity-config.xml file consists of two sections.
l
The Import Tables section contains the declaration of AM tables imported to the AM Generic
Adapter, as well as what attributes and links in a table can be used in the adapter.
l
The Entity Definition section contains the definition of AM entities which are used as the root level
entity for data mapping. An entity is based on a table imported in the Import Table section.
Additionally, an entity can specify a subset of attributes and links in the imported table to limit its
own attributes and links.
Import Tables and Entity Definition
The following tables describe the schema of the am-entity-config.xml file.
Import Tables
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 153 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Name
Type
am-
Tag
Description
tables
name
Attribute
attributes Tag
The SQL name of the AM database table.
Specifies attributes (SQL name) in the table that can be used in the adapter.
Multiple attributes are separated by comma. Use * to import all attributes.
links
Tag
Specifies links (SQL name) in the table that can be used in the adapter.
Multiple links are separated by comma. Use * to import all links.
Note: The table to which the link references must also be imported.
Entity Definition
Name
Type
am-
Tag
Description
entities
am-root-
Tag
entity
name
Attribute
AM entity name. The entity name is used to reference an entity in the data
mapping, AM Class Model, configuration for push, and population. We strongly
recommend that you give it a meaningful name.
table
Attribute
The SQL name of the AM database table where the entity's attributes and
links come from. The table must be imported in the Import Tables section.
inherit-
Attribute
l
from-
True: merge attributes and links defined in the imported table to the
entity.
table
l
False: only attributes and links defined in the entity can be used. The
default value is False.
depth
Attribute
Defines the depth of level links in the entity can be extended. The default
depth is 4, which means the deepest remote link you can use is
entity.linkA.linkB.linkC.linkD.
icon-type
Attribute
The icon to be displayed in the graphic mapping UI to represent the entity. It
refers to the values from UCMDB > Modeling > CI Type Manager > Icon.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 154 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Name
Type
attributes Tag
Description
Specifies the attributes (SQL name) in the table that can be used in the
adapter. Multiple attributes are separated by comma. Use * to import all
attributes.
links
Tag
Specifies the links (SQL name) in the table that can be used in the adapter.
Multiple links are separated by comma. Use * to import all links. Note: The
table to which the link references must be imported.
Out-of-Box Entity Definition
The following table covers all of the out-of-box entities defined in the AM Generic Adapter. For the list of
tables imported to the adapter, see the am-entity-config.xml file.
AM Entity Name
AM Table
Comment
ITEquipment
amComputer
You can customize entity names by suffixing a sub CI
type to define a more exact AM Entity. For example,
l
ITEquipment_Windows
l
ITEquipment_Unix
If you want to query an AM table with different AQL
conditions, you need to separate entities.
Location
amLocation
NetworkCard
amNetworkCard
PhysicalDrive
amPhysicalDrive
SoftwareInstallation
amSoftInstall
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 155 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
AM Entity Name
AM Table
Asset
amAsset
LogicalDrive
amLogicalDrive
Cluster
amCluster
ClusterComponent
amClusterComponen
Comment
t
ExtensionCard
amExtensionCard
Monitor
amMonitor
MonitoredApplication
amMonitoredApp
EmployeeDepartmen
amEmplDept
t
Portfolio
amPortfolio
In practice, you can customize the entity name by AM
natures or models to define more exact AM entities.
For example,
Cluster_Component_
amClusterComponen
Relationship
t
Client_Resource_
amClientResource
l
Portfolio_NetworkHardware
l
Portfolio_StorageConsumer
l
Portfolio_StorageAggregation
l
Portfolio_StorageProvider
l
Portfolio_VirtualMachine
Relationship
Portfolio_Printer
amPortfolio
This entity is for local printers that only saved in
amPortfolio table but not in the amComputer table. It
is used in the data population. Its query condition is:
Model.Nature.Code = 'PRN' AND lParentId <>
0
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 156 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
UCMDB TQL
AM Generic Adapter communicates with UCMDB through TQL queries.
l
For push operations, a TQL query produces CIs which are the source to be translated to Asset
Manager.
l
For population, a TQL query defines CI types to be pulled from Asset Manager.
l
For federation, a TQL query is used to configure the Data Sources of a CI node. For example, you can
specify the Integration Points of a CPU node to an AM Generic Adapter integration point.
l
For graphic mapping UI, a TQL query displays the CI relation tree.
A TQL query used for the data push job must contain a root query node.
In the OOTB TQLs for data push, some query nodes are set with criteria to query valid CIs to be
translated to Asset Manager. For example, "Not NodeRole is null" is one of the conditions specified in
the Node CI of the AM Node Push TQL.
Any attribute used in the mapping flow must be marked in the selected layout of the query node. Each
TQL query may only have one mapping. We recommend that you only add attributes which are used in
the data mapping to the selected layout. Add unused attributes to the selected layout may have impact
on the performance.
You can customize TQLs, for example, add a condition to a query node or add a new query node .
TQL Naming Convention
All OOTB TQLs follow the naming convention below. We recommend that you use the same naming
convention when creating new TQLs for the AM Generic Adapter.
AM <CI Type> <Push | Population> <version #>
For example:
l
AM Node Population 2.0
l
AM Business Element Push 2.0
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 157 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Groovy Functions
Groovy is an agile and dynamic language, natively supported by the Java Virtual Machine. It allows simple
scripting capabilities, while maintaining all the strengths and capabilities of Java. It can execute simple
String manipulation, and use 3rd party libraries. For more information, see http://groovy.codehaus.org/.
Basic Functions
There are two basic function groovy files:
l
AMPopulate.groovy
l
AMPush.groovy
Basic functions in these two files are for implementing data conversion and transformation in mapping
scripts, and they will simplify mapping scripts, although mapping scripts also support basic groovy
syntax.
AM Population Groovy
There are some functions in population groovy implement translation and discrimination logic. The
following list shows all the functions in AMGenericAdapter/mappings/scripts/AMPopulate.groovy.
l
convertlpAddressProperty
l
getAssignment
l
getCRState
l
getHostDataCl
l
getKpiComparisonOperator
l
getLocationType
l
getlpAddressProperty
l
getlpAddressValue
l
getNodeRole
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 158 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
l
getNodeType
l
getServiceClass
l
isAcceptableNode
l
isDebugEnabled
l
isDeletedNode
l
isDesktop
l
isValidLocationParent
l
isValidlp
l
isValidNode
l
isVirtual
l
setLog
AM Push Groovy
There are some functions in push groovy implement business logic conversion, especially for Asset
Manager SAM calculation. The following list shows all the functions in
AMGenericAdapter/mappings/scripts/AMPush.groovy.
l
calculateComputerType
l
convertCsvBytesToString
l
fIsSAIValid
l
fEDDIGetMACAddressEx
l
fEDDIGetACComputerBrand
l
fEDDIGetACWorkGroup
l
fEDDIGetComputerManufacturer
l
fEDDIGetDomainNameEx
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 159 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
l
fEDDIGetSCLogicalName
l
fEDDITruncate
l
getAMPrimarylD
l
getAMPrimarylD
l
getAssetTagCRSystem
l
getBrandName
l
getCardlD
l
getCardName
l
getCardVendorName
l
getClusterModelName
l
getClusterTechnology
l
getCpulnternal
l
getCpuType
l
getCsvFile
l
getDdEdition
l
getDNSSuffix
l
getDomainName
l
getEnd1Externalld
l
getEnd2Externalld
l
getEnumValueByKey
l
getExternalld
l
getFinalModelld
l
getFirstlpV4Address
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 160 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
l
getFirstlpV6Address
l
getFolder
l
getLMSOptionStatus
l
getLMSPacksStatus
l
getlnterfaceDescription
l
getLogicalCpuCount
l
getlpAddress
l
getlpAddress
l
getlpV4SubnetMask
l
getlpV6SubnetMask
l
getlslnventModelExist
l
getlslnventModelResolved
l
getModelldByBarCode
l
getModelName
l
getModelParentCode
l
getMonitorCode
l
getMonitorModelName
l
getNatureCode
l
getNatureCodeFromType
l
getNatureNameFromType
l
getNormalizedCPU
l
getNormalizedModelName
l
getOracleComponentList
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 161 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
l
getOracleEditionShortName
l
getOracleFolder
l
getParentBarCodeFromType
l
getParentName
l
getPhysicalAddress
l
getPrimarylpAddress
l
getSafeAMPrimarylD
l
getSoftwareBarCode
l
getUserName
l
getValueFromCsv
l
getValueFromStringCsv
l
getVMType
l
hasFinalModelld
l
isDHCPEnabled
l
isExtensionCardValid
l
isLparVpar
l
isSolarisZone
l
nicelyPrintExternalld
l
setLog
l
shouldMapMonitor
l
sortlpList
l
validateAndRetrieveSingleUCaseAsset
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 162 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Utility Functions
Some general logic and functions are the same in the utility groovy file. AMPopulate.groovy,
AMPush.groovy, and AMReconcil.groovy are inherited from this groovy. So in push or population
mapping, even the utility groovy is not imported, all of the following functions in
AMGenericAdapter/mappings/scripts/AMUtils.groovy can be used normally.
l
boolTolnt
l
compareDate
l
containslgnoreCase
l
Extractvalue
l
fCleanValueWithDefault
l
fisContainOne
l
flsContainList
l
flsEmpty
l
flsEmptyOrZero
l
isMatchVersion
l
isNull
l
leftPart
l
rightPart
l
toBoolean
l
toSmart
l
toStringList
l
trimRight
l
uCase
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 163 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Reconciliation Functions
Reconciliation groovy file provides advanced features about AM reconciliation proposal, insert or update
script, and so on. The following list shows all the functions in
AMGenericAdapter/mappings/scripts/AMReconcil.groovy.
l
createReconcProposalAdvance
l
getCurrDate
l
getCurrDateLong
l
getlndexByName
l
getModelFromlnstalledSoftwareCl
l
getShortHostName
l
getSqlTextConst
l
getValueBylndex
l
getValueByName
l
isDateAfter
l
isResultEmpty
l
setReconcProposallnvalidate
l
setReconcProposalObsolete
l
stringToDom
l
updateMemorySize
Data Mapping Schema
AM Generic adapter is built on top of the Generic Adapter framework. Its data mapping schema follows
the standard schema in the framework. For more information, see HP Universal CMDB Developer
Reference Guide.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 164 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
The AM Generic Adapter uses some of the elements specifically to fit the AM-UCMDB integration
requirement.
Automatic Creation of Relation CI in Data Population
When populating two CIs that are defined in TQL, their relation CIs are created in UCMDB automatically
according to the TQL query definition. The explicit mapping for the relation between the two CIs is not
required. For example, in the AM Interface Population XML, it does not define the data mapping for the
relation between Interface and Node. However, the relation will be created automatically when you run
the AM Interface Population job.
If you want to create the relation CI with non-default values, you need to define a relation CI mapping in
the mapping XML file.
Define Reconciliation Rule for Target AM Entity in Push
The name attribute of the target_entity tag represents:
l
The entity name defined in the am-entity-config.xml file when defining the target_entity for the
root CI.
l
The link's SQL name in the AM Class Model when defining the target_entity for non-root CIs.
For example, in the AM Node Push.xml, the name of the target_entity for the root CI is set to
ITEquipment, which is an entity type based on the amComputer table. The name of the target_entity for
the Root.File_System CI is set to LogicalDrives, which is the SQL name of the link to the amLogicalDrive
table in the ITEquipment entity.
The type attribute of the target_entity tag represents an alias to be used in the am-push-config.xml file
to define the reconciliation rules for the data mapping. For more information about how to define
reconciliation rules, see "Reconciliation" on page 176.
It is an optional attribute. When it is not given a value, it takes the value of the name attribute as its
value.
For example, in the AM Node Push.xml, the type of the target_entity for the Root.Display_Monitor CI is
set to Monitor-amPortfolio. In the am-push-config.xml file, it uses the type value Monitor-amPortfolio
to define the reconciliation rule for the mapping.
<am-mapping ci-type="Monitor-amPortfolio" name="AddOn" primarykey="lPortfolioItemId" operation-type="update_else_insert" parallel-pushallowed="true" merge-allowed="true" to-version="9.4*">
<reconciliation>
<reconciliation-keys>
<reconciliation-key>Folder</reconciliation-key>
<reconciliation-key>lParentId</reconciliation-key>
</reconciliation-keys>
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 165 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
</reconciliation>
…
</am-mapping>
Specify Sub CI Type in Population Data Mapping
In the population data mapping, the type attribute of the target_entity is used to specify the sub type
of the target CI.
For example, in the AM Node Population.xml, the AM ITEquipment entity is mapped to the Node CI (the
Node CI is set to Root in the TQL query). When the population job is running, the exact CI type the
ITEquipment entity is converted and is determined by the value of the type attribute. In the out-of-box
mapping, it calls a groovy function to set the value of the type attribute.
Determine the Deletion of AM Entities in Population
In the population data mapping, the is-deleted attribute of the target_entity tag is used to determine if
the target UCMDB CI corresponding to the AM entity needs to be deleted.
Produce Log
You can use the Logger object to produce log in the before-mapping and after-mapping tag.
For example,
<before-mapping>Logger.debug('before')</before-mapping>
<after-mapping>Logger.debug('after')</after-mapping>
Population and Federation
AM Generic Adapter is able to retrieve data from AM database via AM DLL API. This section describes the
detailed criteria before query AM Entity.
Criteria for Asset Manager Records to be Populated
AM Entity
AQL
ITEquipment
TcpIpHostName <> '' AND (TcpIpHostName IS NOT NULL)
NetworkCard
Computer.TcpIpHostName <> '' AND (Computer.TcpIpHostName IS NOT NULL)
AND (TcpIpAddress IS NOT NULL) AND (PhysAddress IS NOT NULL) AND
(TcpIpAddress <> '') AND (PhysAddress <> '')
SoftwareInstallation lParentPortfolioId <> 0 AND ParentPortfolio.CMDBId IS NOT NULL AND
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 166 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
AM Entity
AQL
ParentPortfolio.CMDBId <> '' AND ParentPortfolio.Computer.TcpIpHostName <>
'' AND (ParentPortfolio.Computer.TcpIpHostName IS NOT NULL)
Portfolio_Printer
Model.Nature.Code = 'PRN' AND lParentId <> 0
LogicalDrive
Computer.TcpIpHostName <> '' AND (Computer.TcpIpHostName IS NOT NULL)
PhysicalDrive
Computer.TcpIpHostName <> '' AND (Computer.TcpIpHostName IS NOT NULL)
Asset
lAstId <> 0 AND PortfolioItem.Model.Nature.bSystem = 1
Client_Resource_
CRSystem.lAstId <> 0 AND CRSystem.Model.Nature.bSystem = 1
Relationship
Note: If you want to populate the same AM entity with different query condition, you should
duplicate AM entity, rename it to a new entity, and then add an AQL for this new entity.
Transformation for Asset Manager Records to be Populated
IT equipment
The default population mapping will populate an IT equipment when its status is In use or In stock.
According to the IT equipment type, data will be populated to UCMDB as different CI types:
CI types in UCMDB
host_node
nt
HP Universal CMDB (Content Pack 17.00 (CP17))
IT Equipment Type in AM
l
Computer
l
Desktop computers
l
Computer servers
l
Laptop
l
Virtual Machine
l
Smart phone
l
Windows computer
l
Windows desktop computer
Page 167 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
CI types in UCMDB
IT Equipment Type in AM
unix
vmware_esx_server
l
VMware VirtualCenter
l
Unix server computer
l
Unix desktop computer
l
Solaris Zone server
VMware ESX Server
mainframe
lpar
l
Mainframe
l
Mainframe CPC
Mainframe Logical Partition
When a CI is populated to UCMDB, the Host is Virtual attribute of the CI is defined according to the value
of IT Equipment type for the CI in AM.
Host is Virtual
Yes
No
HP Universal CMDB (Content Pack 17.00 (CP17))
IT Equipment Type in AM
l
Virtual Machine
l
Mainframe Logical Partition
l
Windows computer
l
Windows desktop computer
l
VMware VirtuaCenter
l
VMware ESX server
l
Unix server computer
l
Unix desktop computer
l
Solaris Zone Server
l
Desktop computers
l
Computer servers
l
Laptop
Page 168 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Host is Virtual
IT Equipment Type in AM
l
Mainframe
l
ATM switch
l
Firewall
l
Router
l
Switch
l
Network printer
l
Smart phone
l
Mainframe CPC
When a CI is populated to UCMDB, the Host is Desktop attribute of the CI is defined according to the
value of IT Equipment for the CI in AM.
Host is Desktop
Yes
No
HP Universal CMDB (Content Pack 17.00 (CP17))
IT Equipment Type in AM
l
Windows desktop computer
l
Unix desktop computer
l
Desktop computers
l
Windows computer
l
VMware VirtuaCenter
l
VMware ESX server
l
Unix server computer
l
Solaris Zone Server
l
Computer servers
l
Laptop
l
Mainframe
l
ATM switch
Page 169 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Host is Desktop
IT Equipment Type in AM
l
Firewall
l
Router
l
Switch
l
Network printer
l
Smart phone
l
Mainframe CPC
Business Element
In AM, only those business service assets with status (amAsset.Status) Built, Catalogued, Chartered,
Designed , and Requested will be populated to UCMDB. If the status is retired, it will be removed from
UCMDB.
Relations between AM business service asset and CI types are as follows.
Nature code
CI Type
BIZSVC
business_service
BIZAPP
business_application
INFRASVC
infrastructure_service
In AM Generic Adapter, all the transformers and discriminators are implemented in groovy functions. For
more information, see "Groovy Functions" on page 158.
Reconciliation
For each CI Type, the data reconciliation is governed by the reconciliation rule set in UCMDB.
You can check the reconciliation rule for each CI Type on the Details tab of the CI Type. The field name is
Identification.
Population Condition and Push Back Definition
Name
Type
am-
Tag
Description
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 170 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Name
Type
Description
populations
am-
Tag
population
entity-
Attribute
AM Entity name
Tag
The AM database field to hold the global id pushed from UCMDB CI back to
name
push-backfield
AM. It supports AQL syntax, for example:
PortfolioItem.CMDBId
delta-sync-
Tag
date-field
It is used to define a time condition field for AQL in changes population. By
default, it is the field 'dtLastModif' that is from the AM entity which is used
as the 'root-element' in the population mapping.
query-
Tag
condition
The condition of the query to retrieve the entity data from AM. It supports
AM AQL. If the condition includes special characters, for example: >, <, '
surround with CDATA.
Built-in attributes from AM
l
AM_PUSHBACK_ID
This attribute is created by population adapter automatically from AM. It is used to identify which AM
record is written with push back global id.
l
LAST_SYNC_TIME
This attribute is created by population adapter automatically. It keeps the last job changes sync
time in order to be used in population mapping.
Federation Tags
The configuration must be provided if you want to use federation.
It defines all valid federation TQL names.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 171 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Name
Type
supported-federation-queries
Tag
tql-query
Tag
name
Attribute
Description
TQL name
Population Tags
The configuration is used to define all valid population TQL names.
Name
Type
supported-
Tag
Description
population-queries
enable
Tag
l
True: only displays valid population TQL names for you, to select
required population TQLs for a population job.
l
False: displays all TQL names from UCMDB for you, to select
required population TQLs for a population job.
tql-query
Tag
name
Attribute
TQL name
Push and Reconciliation
This section describes push and reconciliation operations.
Data Flow Architecture
The data flow architecture is as follows.
1. The Push Engine executes the TQL query.
2. For a differential flow, the data is compared to the last synchronized data, and only the changes
are forwarded.
3. Data is converted into Composite CIs (instances of data according to the TQL Root elements).
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 172 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
4. Data is then pushed to the Generic Adapter.
5. The Generic Adapter loads the correct mapping for the specific TQL query.
6. All dynamic_mappings are executed and saved to maps, to allow usage in the next mapping stage.
For more information, see "Developing Enhanced Generic Push Adapters" in the HP Universal CMDB
Developer Reference Guide.
7. Data is mapped from the UCMDB data Model into the AM Data model according to the mapping
XML.
8. Data is sent to the AM Connector.
9. AM Connector orders all the data in a set of dependency trees, starting with the records that do
not depend on any other record.
10. AM Connector attempts to merge any duplicate records
11. AM Connector starts reconciling and pushing any record without any dependencies, or a record
whose dependencies have already been reconciled/pushed to Asset Manager.
a. AM Connector first tries to reconcile with existing records.
b. If it finds a match, it attempts to update that record.
c. If it does not find a match, it attempts to create a new record.
12. AM Connector deletes any records that are required to be deleted in AM, as permitted by actionon-delete.
Integration TQL Queries
A TQL query used for the integration must contain a root query node.
Any attribute using in the mapping flow of the data push must be marked in the selected layout of the
query node.
Each TQL query for data push job may only have one mapping.
For more information, see Data Flow Management > Integration > Integration Studio > Integration
Jobs Pane.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 173 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Reconciliation Proposals
When pushing data to Asset Manager, there is an option to create a reconciliation proposal (RP). A
reconciliation proposal should be created if there is a change in a specific attribute that may need AM
Operator validation or action to support AM business processes.
The OOTB configuration creates a reconciliation proposal record when the memory size of the pushed
computer has decreased compared to the AM computer.
How to use Reconciliation Proposals
In the OOTB configuration lMemorySizeMb is marked for attribute-reconciliation. The update script calls
the updateMemorySize function. This function verifies if the memory size of the computer was
decreased. It initializes all the parameters that are passed to the function
validateReconcUpdateAdvance. Calls validateReconcUpdateAdvance and return its returned value.
validateReconcUpdateAdvance is a function that returns the value that should be set to the attribute
according to the Reconciliation Proposal status. The following table describes its parameters:
Parameter
Description
AMApiWrapper
The wrapper that is used to communicate with the AM.
newVal
The value of the attribute in the pushed data.
oldVal
The value of the attribute that is retrieved from AM.
recordId
The primary key of the table that the attribute belongs to.
strCode
The prefix of the code field in the reconciliation proposal.
strName
The name of the reconciliation proposal.
path
The name of the attribute.
recordTable
The table that the attribute belongs to.
validateReconcUpdateAdvance returns the value that should be set for the attribute, according to the
Reconciliation Proposal status.
In order to create a reconciliation proposal flow on a different attribute, the following steps must be
completed:
1. Add the <attribute-reconciliation> tag for this attribute.
2. The update-script should call a new function that initializes the parameters passed to
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 174 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
validateReconcUpdateAdvance, and returns the value returned from
validateReconcUpdateAdvance.
Note: We recommend that you use the updateMemorySize function as a reference.
Asset Manager Rules and Flows
Asset Manager has its own set of rules and flows that are enforced by the Asset Manager API. Some
customizations may need to later these rules and flows as well. For more information, see the Asset
Manager documentation.
Mapping Attributes
Attributes in the <am-mapping-config> tag are as follows
Attribute
Description
ci-type
It is used in am-push-config.xml to recognize the reconciliation rule. It must be the same
as the 'type' attribute in AM mapping XML files.
For example:
l
Mapping file AM Node Push.xml: <target_entity name="AddOn" type="'PrinteramPortfolio'">
l
Reconciliation file am-push-config.xml: <am-mapping ci-type="Printer-amPortfolio"
name="AddOn" …>
name
AM entity name or sub link name.
primarykey
The primary key column in the AM database schema.
operation- It defines what operations may be done with the record.
type
insert - Only allows creation of new records; if it already exists, an exception is thrown.
update - Only allows updates of an existing record; if it does not exist, an exception is
thrown.
update_else_insert - If the record exists, it is updated. Otherwise, the record is created.
reference-only - The record is only used for being referenced by other records (and is
not updated). An exception is thrown if the record does not exist.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 175 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Attribute
Description
ignore - The record is unaffected by operations.
insert_else_reference - If the record does not exist, it is created. Otherwise it is only
used as a reference and is not be updated; see reference-only.
optional_reference - If reconciliation fails, it will not fail dependent CIs. Instead, 0 value
is returned as ID.
parallelpushallowed
If enabled with the enabled-parallel-push configuration of the integration point, will
mergeallowed
If enabled and this entity is an exact duplicate of another entity in the chunk, it merges
attempt to push to the entity with multiple threads in order to increase performance.
both entities into one and fixes any relevant references.
errorcode- If used together with the adapter specific errors, allows the printing of a customized.
override
error message to the UI if the push or reconciliation of this entity fails.
fromversion
Use this mapping only from (and including) this version. The version is taken from the
to-version
Use this mapping only up to (and including) this version. The version is taken from the
integration point configuration.
integration point configuration.
Reconciliation
Reconciliation defined for each mapping may include more than one set of reconciliation rules. When
attempting to reconcile the record with existing ones in the AM database, the AM Connector tries each
of the reconciliation sets until it finds a matching record. Priority is defined by the order of
reconciliation rules. If no record in the AM database matches this record, an insert operation is
performed if the operation type permits it.
Name
Type
Description
reconciliation
Tag
Parent XML tag for all reconciliation configuration.
reconciliation- Tag
keys
Represents a single reconciliation rule that may be made of one or more
attributes. All attributes inside the rule must match in order for the
reconciliation of this rule to be successful.
reconciliation- Tag
key
Represents a single attribute used for reconciliation as part of the
reconciliation-keys rule.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 176 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Name
Type
Description
Ignore-case
Attribute
Part of the reconciliation-key tag. Specifies that this attribute
comparison ignores case.
reconciliation- Tag
advanced
Allows definition of the reconciliation rule by manually defining the
WHERE clause of the AQL (Asset Query Language). Uses GString (Groovy
String) to generate the replacement String. Any variable or property
defined in this record or its parent during the mapping stage (in the Push
Adapter) may be used as a variable in the GString. (See
http://groovy.codehaus.org/Strings+and+GString for more information).
Note: AMPushAdvancesReconciliationException may be thrown
inside this tag to skip to the next rule.
follow-parent
Tag
Used to define overflow tables. See the AM documentation for more
information on overflow tables. When using follow-parent, no other
reconciliation may be used as this target CI has a 1:1 connection with its
parent, and it uses the parent reconciliation to push data to AM.
am-prefix
Attribute
Part of the follow-parent tag. Defines the name that the parent target
CI uses to reference to this table. (To find out the correct value, navigate
to AM Application Designer > Edit Links).
Example:
<reconciliation>
<reconciliation-advanced>Portfolio.CMDBId = '${if(globalId==null) { throw new
com.hp.ucmdb.adapters.ampush.exception.
AMPushAdvancesReconciliationException
('Not enough reconciliation data') }else{ return globalId}}'
</reconciliation-advanced>
<reconciliation-keys>
<reconciliation-key ignore-case="true">AssetTag</reconciliation-key>
</reconciliation-keys><reconciliation-keys>
<reconciliation-key>TcpIpHostName</reconciliation-key>
<reconciliation-key>Workgroup</reconciliation-key>
</reconciliation-keys>
</reconciliation>
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 177 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Target CI Validation
This tag allows the definition of a validation rule that is executed on specific attribute values: the new
one held in memory, and the old one stored in the AM database.
The following table shows the attributes of the <target-ci-validation> tag:
Name
Description
attributename
The attribute that you want to use for validation.
validationscript
A Groovy based script that returns true if this record is to be pushed, and false if it is
not to be pushed. The script may access any external Groovy code in the path in order
to run the evaluation.
failedvalidationerror-code
l
vNewVal - Attribute value of the record in memory.
l
vOldVal - Attribute value of the record in the AM database.
This optional attribute holds the error code that appears if there is a validation failure.
The arguments that can be referenced in the error message are:
l
{0} - The validated attribute name.
l
{1} - The property value in UCMDB.
l
{2} - The property value in Asset |Manager.
l
{3} - The validation script.
l
{4} - The additional message from the additional-failure-message attribute, or
'null' if there is no additional message.
additionalfailuremessage
This optional attribute holds an additional error message that can be referenced by
the error message in the properties.error file. See failed-validation-error-code,
above.
Example:
<target-ci-validation attribute-name="dtLastScan" validationscript="mappings.scripts.AMReconciliationAdvanced.isDateAfter(vNewVal,vOldVal)"/>
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 178 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Reference Attribute
A reference attribute defines a column that references another record from a different or same table.
This record is not pushed, or reconciled against existing AM database records, until this reference is
resolved. Resolved references are replaced by a reference ID that represents the primary ID of the
referenced record.
The following table shows the attributes of the <reference-attribute> tag:
Name
Description
ci-name
The CI-type of the referenced record.
datatype
The value type of the record.
name
The column in the current record that is to be populated by the reference ID.
referencedirection
According to the tree created by the Push Adapter, the value specifies if the
referenced record is a parent or child of the current record.
Example:
<reference-attribute ci-name="SW_amModel" datatype="STRING"
name="lModelId"reference-direction="child"/>
Attribute Reconciliation
This tag allows the AM connector to decide what to do with an attribute value according to the existing
value in the AM database.
The following table shows the attributes of the <attribute-reconciliation> tag:
Name
Description
attribute- The attribute to be reconciled.
name
updatescript
The script to execute in case of an update operation on the record. The returned value by
the groovy script will be push to AM as the value of this attribute.
l
vNewVal - Attribute value of the record in memory.
l
vOldVal - Attribute value of the record in the AM database.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 179 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Name
Description
Insertscript
The script to execute in case of an insert operation on the record. The value returned by
the Groovy script is pushed to AM as the value of this attribute.
vNewVal - Attribute value of the record in memory.
Example:
<attribute-reconciliation attribute-name="AssetTag" update-script=
"mappings.scripts.AMPushFunctions.fIsEmpty(vOldVal) ? vNewVal : vOldVal"/>
Action on Delete
This tag allows customization of the behavior on receipt of a delete notification for a record.
Note: No deletion occurs if the Allow Delete option in the job definition is disabled.
The following actions are possible
l
<ignore> - Do nothing.
l
<delete-ci> - Delete this record from the AM database.
l
<set-attribute-value> - Change the value of one or more attributes in the AM database.
Example:
<action-on-delete>
<set-attribute-value name="bMissing" datatype="BOOLEAN" value="1"/>
</action-on-delete>
Enum Attribute
This tag allows a specific enum attribute to be pushed in a serial mode, when the adapter is configured
to push data in parallel mode.
Note: This option exists to prevent duplicate key exceptions occurring when several threads push
the same enum value.
The following table shows the attributes of the <enum-attribute> tag:
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 180 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Name
Description
attribute-name
The enum attribute name.
itemized-name
The itemized list format (amOS) of the enum.
Ignored Attributes
This tag allows specific attributes to be ignored and not pushed to the AM database. This capability is
commonly used with the from-version and to-version attributes or tags, to ignore certain attributes for
specific versions of Asset Manager.
The following table shows the attributes of the <ignored-attributes> tag:
Name
Description
fromversion
Ignore this attribute only from (and including) this version. The version is taken from the
toversion
Ignore this attribute only up to (and including) this version. The version is taken from the
integration point configuration.
integration point configuration.
Example:
<ignored-attributes>
<ignored-attribute>lSeq</ignored-attribute>
</ignored-attributes>
Deletion
To allow the AM Generic Adapter to delete CIs in UCMDB on data population or delete assets in AM on
data push, additional configurations are required. The following sections describes how to configure the
AM Generic Adapter to allow data deletion in the AM-UCMDB integration.
Population Deletion Configuration
When a computer is retired in Asset Manager, the corresponding CI in UCMDB should be deleted as well.
By default, it is not allowed to delete CIs from UCMDB through the AM population jobs. You need to
complete the following three steps to allow population jobs to delete CIs from UCMDB.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 181 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
1. In population job definition, enable Allow Integration Job to delete removed data to allow mapping
script to send delete CI action to the UCMDB server.
2. In population mapping script, use the Is-deleted attribute on target-entity to determine what CIs
should be deleted. You may also configure it from the graphic mapping UI.
3. Choose the Deletion Method in the Adapter Setting.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 182 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Push Deletion Configuration
When a CI is deleted from UCMDB, the corresponding asset record in AM should be deleted as well. By
default, it is not allowed to delete assets from AM through the AM push jobs. You need to complete the
following steps to allow push jobs to delete assets from AM.
1. In the push job definition, enable Allow Deletion for TQL queries which are allowed to delete asset
records in AM.
2. Define the Action on Delete for the target AM entity type in the am-push-config.xml file. For more
information, see "Action on Delete" on page 180.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 183 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Installed Software / Software Utilization
The Integration supports the following different flows for pushing Installed Software or Software
Utilization to Asset Manager. You may switch between these flows.
Note: The following sections describe three different flows for Installed Software. The same flows
also apply to Software Utilization (User_Software_Utilization).
Note: The flows below show a simplified high-level flow of the different Installed Software or
Software Utilization synchronization behavior. The actual behavior may be more complex in some
cases, mainly for performance improvement. See also "Switching between Installed Software and
Software Utilization Flows" on page 186 and "Installed Software / Software Utilization" above.
Normalized Installed Software
This flow uses an InventoryModel to catalog each exact Software Version. Therefore, if the AM Operator
decides to map a certain Software version to a different model, he only has to do it once to the
Inventory Model, and does not have to process all the Installed Software in AM. This flow allows using
either the SAI Version ID, or the attributes name, version, and vendor, to correctly reconcile the Installed
Software, and uses the information to automatically create Models according to major versions as
needed.
1. Each Installed Software is first mapped to an Inventory Model. If one does not exist, it creates one.
The mapping is done according to the SAI Version ID which is an inventory ID from the Universal
Discovery Scanner, or by using the Installed Software's name, version, and vendor.
2. It then sees if the InventoryModel has a final mapping to a Model. If it is a new InventoryModel, or
the InventoryModel has no final mapping to a Model, it attempts to search for one with the same
name and version. If one is found, it connects the InventoryModel to it; otherwise it creates a new
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 184 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Model.
3. It then connects the Installed Software to the Model as well.
Note: Normalized Installed Software is the default flow.
Normalized Installed Software – No Model Creation
This flow uses an InventoryModel to catalog each exact Software Version. Therefore, if the AM Operator
decides to map certain Software version to a different model, he only has to do it once to the
InventoryModel, and does not have to process all the Installed Software in AM. This flow does not
automatically create a Model. Instead, the Model must be connected to the InventoryModel by a
different flow, or manually by an Asset Manager Operator.
1. Each Installed Software is first mapped to an Inventory Model. If one does not exist, it creates one.
The mapping is done according to the SAI Version ID, which is an inventory ID from the Universal
Discovery Scanner, or by using the Installed Software attributes: name, version, and vendor.
2. It then sees if the InventoryModel has a final mapping to a Model. If not, it chooses the temporary
model (an Unknown Software Model).
3. It then connects the Installed Software to the Model found in the step 2.
4. Later, an Asset Manager Operator manually connects each Inventory Model to a final Model, as he
wishes.
Non-Normalized Installed Software
This flow pushes Installed Software and Models only. (It does not map or use the Inventory Models in any
way).
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 185 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Each Installed Software is mapped to a matching Model which is created if not found.
Switching between Installed Software and Software Utilization Flows
There are four OOTB TQLs for the Installed Software and Software Utilization push in the AM Generic
Adapter.
l
AM Installed Software Push 2.0 is the TQL that contains the Installed Software CIs which need to be
normalized in Asset Manager. Running this TQL job triggers the installed software flow that is
normalized.
l
AM Software Utilization Push 2.0 is the TQL that contains the Software Utilization CIs which need to
be normalized in Asset Manager. Running this TQL job triggers the software utilization flow that is
normalized.
l
AM Installed Software Normalized Push 2.0 is the TQL contains the Installed Software CIs which are
already normalized in UCMDB and do not need to be normalized in Asset Manager. Running this TQL
job triggers the installed software flow that is not normalized.
l
AM Software Utilization Normalized Push 2.0 is the TQL contains the Software Utilization CIs which
are already normalized in UCMDB and do not need to be normalized in Asset Manager. Running this
TQL job triggers the software utilization flow that is not normalized.
Mapping UI
You can use the graphic mapping UI to develop data mappings for the AM Generic Adapter. For more
information about the mapping UI, see the Data Flow Management Guide.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 186 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
AM Class Model displayed on Mapping UI
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 187 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Prerequisites for using Mapping UI
l
You have established an integration point with AM Generic Adapter.
l
The integration point has been activated.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 188 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
How to Tailor the Integration
This section describes how to tailor the integration.
How to Change Adapter Settings
To change adapter settings, follow these steps.
1. Go to Data Flow Management > Adapter Management > AMGenericAdapter > Adapters.
2. Right-click AMGenericAdapter, and then click Edit Adapter Source.
3. Scroll down to the <adapter-settings> tag.
4. Edit the settings as required and click Save.
Setting
Default
Description
replication.chunk.size
4000
Defines the requested number of
CIs and Relations sent in each
chunk. It is possible to adjust this
setting to try and improve the
performance of the server and the
probe.
replication.chunk.root.limit
850
Defines the maximum requested
number of Roots sent in each
chunk. This works with
replication.chunk.size as a limiter
on the amount of data sent in each
chunk.
PushConnector.class.name
The name of the Java class used to
load the AM Connector.
parallel.thread.pool.size
8
The amount of threads used in
Parallel Push Mode. The more
threads, the more CPU used.
Increasing the pool size may lower
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 189 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Setting
Default
Description
performance.
mapping.size.fuse
100000
The maximum number of records
the AM Connector may to retrieve
in <dynamic_mapping> .
transaction.deadlock.max.retry.count
15
The maximum number of attempts
the AM Connector reconnects to
the database when deadlock
occurs, network is broken, or
database is down. The interval time
is 1.5 ~ 3 seconds.
am.reconnect.db.code
<!--MSSQL-->
SQLSTate:08001;
SQLSTate:08S01;
SQLSTate:01000;
<!--ORA-->
ORA-01033;
ORA-03113;
ORA-12543;
ORA-12541;
ORA-12518;
<!--DB2-->
SQL30080N;
SQL30081N;
The error codes are used to check
if the database exception is raised
by network or database instance
down. The AM Connector will try to
reconnect to the database if one of
these error codes is received.
You can also add other error codes
to meet your requirements.
Configure Federation CI types
In adapterInfo > adapter-capabilities > support-federated-query > supported-classes >
supported-class, all supported CI types are defined in the out-of-box federation mapping.
o
node
o
installed_software
o
Cpu
o
disk_device
o
file_system
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 190 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
o
logical_volume
o
Printer
You can modify them to enable or disable the supported CI Types as shown in the Integration point >
Federation pane.
How to Customize an Existing Mapping
AM Generic Adapter allows you to modify existing out-of-box mappings with Mapping UI. You can edit
the mapping XML file directly.
To modify a mapping file using the visual mapping tool
Go to UCMDB Client > Data Flow Management > Adapter Management > AMGenericAdapter >
Configuration Files. Mapping UI can open those XML mapping files in the following sub folders in the
AMGenericAdapter/mappings folder:
l
Federation
l
Population
l
Push
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 191 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
When you click a mapping XML file, a dialog pops up. You can choose to use new mapping tool editor to
edit this mapping file.
If you click Yes, the mapping XML file will be opened in the graphic mapping UI. The following screenshot
shows the AM Node Population.xml file opened in the mapping UI.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 192 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
For details about the mapping UI, please see Data Flow Management Guide.
If you want to populate one more attribute AssetStatus of Asset from AM to UCMDB, you need to
complete the following steps.
1. If the attribute in AM is not exposed from the AM database to the AM Class Model, add it to the amentity-config.xml file. For example, the Field1 attribute is not part of the out-of-box AM Class
Model, you need to add it to the amAsset table in the am-entity-config.xml file.
<am-table name="amAsset">
<attributes>AssetTag,sMaxCnxCount,SerialNo,Description,Status,AssetStatus</attr
ibutes>
<links>Model,PortfolioItem</links>
</am-table>
In this example, the attribute in AM to map to the AssetStatus attribute is status. As it is already in
the out-of-box AM Class Model, you do not need to modify the am-entity-config.xml file.
2. In the Local Query pane, select the Asset node.
3. Select the AssetStatus attribute and add it to the mapping definition.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 193 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
4. In the mapping definition pane, you will see asset_status is presented under the Asset node.
5. From the right side External Class Model, select Asset, find the attribute Status, then click the Add
button, or drag it to asset_status in middle directly.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 194 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
6. The mapping is created.
You can also populate the value part of the mapping by using the auto-complete feature in the mapping
UI. For example, type ITEquipment, it will show all of the links and attributes of ITEquipment. After select
Portfolio, it will show portfolio's links and attributes. Continue operating this way, you will be able to get
the same text in the value field.
For more information about Mapping UI features, see Data Flow Management Guide.
How to Add a New Mapping to the Integration
To create a mapping file using the visual mapping tool, you need to complete the following steps.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 195 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
1. Go to UCMDB Client > Data Flow Management > Adapter Management > AMGenericAdapter,
click the Create New Resource icon.
2. Click New Configruation file.
3. In the popup window, Package is already specified to AMGenericAdapter. Type a name for mapping
file, for example, AMGenericAdapter/mappings/population/AM example Population.xml.
4. In the window asking you if you want to open it in the mapping tool editor, click Yes.
5. After the Mapping UI is loaded, you need to add a TQL Query in the Local Query pane. If you are
editing a push mapping, it displays all TQL queries when adding TQL query. If you edit population
and federation mapping, it displays those TQLs defined in the supported-population-queries and
supported-federation-queries in the am-populate-config.xml.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 196 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
6. Other steps are same as editing an existing mapping.
For more information, see Data Flow Management Guide.
How to Populate Asset Manager Contract
Contract management is one of the modules built in Asset Manager. The out-of-box Asset Manager to
UCMDB data population content package does not contain the data mapping for contract. This sample is
to introduce the procedure of mapping the contract data from Asset Manager to UCMDB from scratch.
Step 1. Define the Contract Entity
1. In the UCMDB client, go to Data Flow Management > Adapter Management.
2. Expand Packages > AMGenericAdapter > Configuration Files, open AMGenericAdapter/config/amentity-config.xml.
3. Append the following lines to the am-tables section.
<am-table name="amContract" icon-type="contract">
<attributes>Ref,seType,Purpose,ContractNo,seStatus</attributes>
<links></links>
</am-table>
4. Append the following line to the am-entities section.
<am-root-entity name="Contract" table="amContract" inherit-from-table="true"/>
5. Save the changes.
6. Open the AMGenericAdapter/config/am-populate-config.xml file.
7. Append the following lines to the am-populations section.
8. Save the changes.
Step 2. Create a TQL Query
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 197 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
1. In Model Studio, create a new TQL query "AM Contract Population 2.0" with Contract CI type as its
only content.
2. Save the query under Integration/AMGenericAdapter/population.
3. Add the TQL to the supported population queries in the population configuration file: am-populateconfig.xml.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 198 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Step 3. Create a Data Mapping File
1. In Adapter Management, expand Packages > AMGenericAdapter > Configuration Files.
2. Click the Create new resource button and select New Configuration File.
3. In the pop-up window, fill in the fields with the following values.
Name: AMGenericAdapter/mappings/population/AM Contract Population.xml
Package: AMGenericAdapter
4. In the pop-up window, click Yes to use Mapping UI to edit mapping file.
5. In the mapping UI, create a target mapping for the document_reference attribute. Then, you
should get the following content of the mapping file.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<integration>
<info>
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 199 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
<source name="AM" vendor="HP" version="9.41"/>
<target name="UCMDB" vendor="HP" version="10.20"/>
</info>
<import>
<scriptFile path="mappings.scripts.AMPopulate"/>
</import>
<target_entities>
<source_instance root-element-name="Contract" query-name="AM Contract
Population 2.0">
<target_entity name="Contract" type="'license_contract'">
<target_mapping datatype="STRING_LIST" ignore-on-null="false"
name="document_reference" value="AMPopulate.toStringList(Contract['Ref'])"/>
</target_entity>
</source_instance>
</target_entities>
</integration>
Note: You can also overwrite the content of the AM Contract Population.xml file with the above
content in the text edit mode.
Step 4. Specify Sub CI Type for Contract
As the Contract CI type is abstract, which cannot be instantiated. A sub CI type must be specified in the
target mapping to inform UCMDB of what exact CI should be created. In the above mapping file, it
explicitly sets the CI type to license_contract. In Asset Manager, there are a number of contract types
that correspond to the sub type of Contract in UCMDB. You can use the type attribute of the target_
entity element to specify the exact type of the contract according to the contract type in Asset
Manager.
1. Go to Data Flow Management > Adapter Management.
2. Expand Packages > AMGenericAdapter > Configuration Files and open the file
AMGenericAdapter/mappings/scripts/AMPopulate.groovy.
3. Add the following line below the line 24.
private static Map<Integer, String> contractTypes = new HashMap<Integer,
String>();
4. Add the following lines to the end of the static section.
contractTypes.put("0", "contract");contractTypes.put("1",
"lease_contract");
contractTypes.put("2", "lease_contract");
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 200 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
contractTypes.put("3", "insurance_contract");
contractTypes.put("4", "maintenance_contract");
contractTypes.put("5", "license_contract");
contractTypes.put("6", "procurement_contract");
contractTypes.put("7", "service_level_agreement");
contractTypes.put("8", "service_level_agreement");
contractTypes.put("9", "operational_level_agreement");
contractTypes.put("10", "operational_level_agreement");
contractTypes.put("11", "procurement_contract");
5. Create a groovy function to get the sub CI type of the contract corresponding to the AM contract
type.
public static String getContractType(String seType) {
return contractTypes.get(seType);
}
6. Update the mapping file to replace the value of the type attribute with a call to the groovy
function.
<target_entity name="Contract" type="AMPopulate.getContractType(Contract
['seType'])">
7. Add a variable to retrieve the data of the seType field.
<variable name="vType" datatype="STRING" value="Contract['seType']"/>
8. Add a mapping for the contract_ref attribute which is required in the identification rule of some
sub type of Contract.
<target_mapping datatype="STRING" name="contract_ref" value="Contract['Ref']"/>
9. In the end, you should have the following content in the mapping file.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<integration>
<info>
<source name="AM" vendor="HP" version="9.41"/>
<target name="UCMDB" vendor="HP" version="10.20"/>
</info>
<import>
<scriptFile path="mappings.population.scripts.AMPopulate"/>
</import>
<target_entities>
<source_instance root-element-name="Contract" query-name="AM Contract
Population 2.0">
<target_entity name="Contract" type="AMPopulate.getContractType
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 201 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
(Contract['seType'])">
<variable name="vType" datatype="STRING" value="Contract
['seType']"/>
<target_mapping datatype="STRING_LIST" ignore-on-null="false"
name="document_reference" value="AMPopulate.toStringList(Contract['Ref'])"/>
<target_mapping datatype="STRING" name="contract_ref"
value="Contract['Ref']"/>
</target_entity>
</source_instance>
</target_entities>
</integration>
Step 5. Map More Fields
Besides the mapping for the document_reference and contract_ref fields, you can map more fields as
needed. Below is the content of the mapping file with more field mappings.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<integration>
<info>
<source name="AM" vendor="HP" version="9.41"/>
<target name="UCMDB" vendor="HP" version="10.20"/>
</info>
<import>
<scriptFile path="mappings.scripts.AMPopulate"/>
</import>
<target_entities>
<source_instance root-element-name="Contract" query-name="AM Contract
Population 2.0">
<target_entity name="Contract" type="AMPopulate.getContractType
(Contract['seType'])">
<variable datatype="STRING" name="vType" value="Contract
['seType']"/>
<target_mapping datatype="STRING_LIST" ignore-on-null="false"
name="document_reference" value="AMPopulate.toStringList(Contract['Ref'])"/>
<target_mapping datatype="STRING" name="contract_ref"
value="Contract['Ref']"/>
<target_mapping datatype="STRING" name="description"
value="Contract['Purpose']"/>
<target_mapping datatype="STRING" name="name" value="Contract
['Ref']"/>
<target_mapping datatype="STRING" name="data_note"
value="Contract['ContractNo']"/>
</target_entity>
</source_instance>
</target_entities>
</integration>
Step 6. Create a population job
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 202 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
In the Integration Studio, locate the integration point you created to connect to Asset Manager. Follow
these steps to create the job for contract data population.
1. Switch to the Population tab.
2. Click the New Integration Job button.
3. Add the AM Contract Population 2.0 query to the Job Definition.
4. Name the job and click OK to save the job.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 203 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Step 7. Execute the Job
Select the newly created job and click the Full Synchronization button to start the job. After the job
completes, the statistics pane displays the result of the job execution.
You can double-click each line of the statistics pane to view the details of the CIs.
How to Set up Federation
AM Generic Adapter supports federation feature. For more information, refer to HP Universal UCMDB
Developer Reference Guide, Chapter: How to Set Up Federation.
Federation mappings have the same design as population, it is the same to retrieve AM data from AM
entity and to use same query condition definition.
When you create TQL queries for federation in AM Generic Adapter, you need to save them in the
Integration/AMGenericAdapter/federation folder.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 204 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
How to Set up Integration in a Multi-Tenant Environment
When a single instance of software runs on a server, serving multiple client organizations (also known
as tenants), the environment is called a multi-tenant environment. Both Asset Manager and UCMDB
support multi-tenancy.
UCMDB also has a legacy multi-customer setting that is different from the multi-tenant feature
described in this document.
The current AM-UCMDB integration supports a limited solution that pushes one UCMDB tenant to a
tenant in Asset Manager, without having to modify exist mapping files or scripts.
l
For data push from UCMDB into AM, customization is done by setting a TQL filter condition and
assigning AM User's primary tenant privilege.
l
To populate specified asset data from AM into UCMDB, customization is done by setting an AQL
query condition in AM and the Default Owner Name parameter in UCMDB Integration Point.
In UCMDB multi-tenancy environments, all discovered CIs/relationships are assigned an owner tenant
that has full permission on the resource or CI.
l
When data is populated into UCMDB, a default owner name can be defined in a parameter of the
integration.
l
When data is pushed from UCMDB, the owner name is used to set a filter tenant.
In Asset Manager multi-tenant environments, a primary tenant is a property or privilege of a user, which
enables the user to manipulate data in a specified tenant. A user can have one primary tenant at one
time. By default, when a user creates a record, the record is created in the primary tenant.
l
To pull data from AM into UCMDB, the link Tenant.Code can be used as an AQL in AM.
l
To push data from UCMDB into AM, use the AM user who has the primary tenant privilege.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 205 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Viewing tenant list in UCMDB
Open the UCMDB web GUI, connect as Admin.
Select Tenants Management from the Security module on the Navigation Menu. Or, select Managers >
Security > Tenants Management.
View tenant list in Asset Manager
Open Asset Manager web or Windows client.
Display the tenants (Administration > Multi tenancy > Tenants) link on the navigation bar.
Define a tenant for data pushed into UCMDB
Data to be pushed into UCMDB may have a tenant specified in one of the following objects.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 206 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
l
The integration point (to populate data in one UCMDB tenant)
l
A configuration file (to populate data in UCMDB from one AM tenant)
Default owner name in the integration point
The tenant owner of the data pushed into UCMDB can be specified manually from the integration point
when multi-tenancy is enabled.
1. Log on to UCMDB as an administrator.
2. Go to Data Flow Management > Integration Studio. UCMDB displays a list of existing integration
points.
3. Display the appropriate integration point.
4. A default tenant owner can be selected in the integration point.
This setting does not take effect on the data pushed from UCMDB into Asset Manager (it does not filter
the CIs pushed from UCMDB).
Set AQL query condition in am-populate-config.xml
Edit AM Generic Adapter, go to Data Flow Management > Adapter Management > AMGenericAdapter >
Configuration Files:
AMGenericAdapter/config/am-populate-config.xml
Add the tenant information in the XML in the query-condition, as shown below (the example is for a
tenant named "HP").
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 207 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Matrix and solution brief
This table describes 4 modes:
l
SS (Shared to Shared, i.e. No Tenant in Both Systems)
l
TS (1 Tenant to Shared)
l
TT (1 Tenant to 1 Tenant)
l
ST (Shared to 1 Tenant)
Shared = No tenant implemented in the software (also described as Non-MT in the table below).
MT = Multi-tenancy is turned on.
It shows how to implement AM adapters for multi-tenant environments between Asset Manager and
UCMDB.
l
GA (Push): the push part of AM Generic Adapter.
l
GA (Pop): the population and federation parts of AM Generic Adapter. Pulling CIs and relationships
from Asset Manager to UCMDB.
l
Push: AM Push Adapter
l
Pop(DB): AM Adapter based on GDBA: Generic Database Adapter (population and federation)
Mode UCMDB
AM
GA(Push)
GA(Pop)
Push
Pop(DB)
SS
Non-
Non-
Default
Default
Default
Default
MT
MT
MT
MT
TT Mode GA
TT Mode GA
Same as with GA
TT Mode Pop
(push)
(Pop)
push
(DB)
ST Mode GA
ST Mode GA
Same as with GA
ST Mode Pop
(Push)
(Pop)
push
(DB)
Non-
TS Mode GA
TS Mode GA
Same as with GA
TS Mode Pop
MT
(Push)
(Pop)
push
(DB)
TT
ST
Non-
MT
MT
TS
MT
In the examples below, the configuration is set to use "Tenant1". This value has to be replaced by the
correct value of the tenant (for example, "HP").
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 208 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
TT Mode GA (Push)
Pushes CIs from one UCMDB tenant into one Asset Manager tenant
l
Log on to UCMDB with the Admin account (who can consume all tenants CIs)
l
Filter TQL: set Owner Tenant to Tenant1
l
Grant an AM user the administrator rights and set the primary tenant to Tenant1
l
Configure AM Push adapter Integration Point to push with this user
TT Mode GA (Pop)
Pushes assets from one AM tenant into one tenant in UCMDB
l
In the Integration Point, set the user for AM so it has administrator rights and can view all data for
Tenant1 (The Admin account can also view all the data).
l
Set Default owner name to Tenant1 in the Integration Point.
l
Filter AQL in the population configuration file: in the query-condition, append Tenant.Code =
'Tenant1'.
ST Mode GA (Push)
Pushes CIs from UCMDB (no tenant) into one AM tenant
l
Log on to UCMDB with Admin account (who can consume all tenants CIs).
l
Filter TQL: possibly add TQL conditions to filter CIs to be pushed to AM Tenant1.
l
Grant an AM user the administrator rights and set the primary tenant to Tenant1.
ST Mode GA (Pop)
Pushes assets from one AM tenant into UCMDB with no tenant
l
In the Integration Point, set the user for AM so it has administrator rights and can view all data for
Tenant1 (The Admin account can also view all the data).
l
Filter AQL in population configuration file: in the query-condition, append Tenant.Code = 'Tenant1'.
TS Mode GA (Push)
Pushes CIs from one UCMDB tenant into AM (no tenant)
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 209 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
l
Log on to UCMDB with Admin account (who can consume all tenants CIs).
l
Filter TQL: set Owner Tenant to Tenant1 (or customize the filter value to multiple tenants to push CIs
of several tenants into AM).
l
Grant an AM user the administrator rights; configure AM Push adapter Integration Point to push with
this user.
TS Mode GA (Pop)
Pushes assets from one AM (no tenant) into one UCMDB tenant
l
Set the AM Admin account (who can view all assets to be pushed) for AM Integration point.
l
Set "Default owner name" to Tenant1 in the Integration Point.
l
Filter AQL in population configuration file: in the query-condition, append some AQLs to filter assets
that belong to Tenant1.
TT Mode Pop (DB)
Pushes assets from one AM tenant into one UCMDB tenant
l
Update SQL views in AM DB, join the amTenant table and add the amTenant.Code column as
TenantCode.
l
Filter tenant in the table tag in orm.xml, for example: View_hostExtend.
<table name="(select * from View_hostExtend where TenantCode='Tenant1')
"></table>
l
Set "Default owner name" to Tenant1 in the Integration Point.
TS Mode Pop (DB)
Pushes assets from one AM tenant into UCMDB with no tenant
l
Update SQL views in AM DB, join the amTenant table and add the amTenant.Code column as
TenantCode.
l
Filter tenant in the table tag in orm.xml, for example: View_hostExtend.
<table name="(select * from View_hostExtend where TenantCode='Tenant1')
"></table>
TS Mode Pop (DB)
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 210 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Pushes assets (no tenant) into one UCMDB tenant
l
Update SQL views in AM DB or filter SQL in the table tag in orm.xml based on the logic to select
Tenant1 data, for example: TcpIpDomain=’tenant1.com’
l
Set "Default owner name" to Tenant1 in the Integration Point.
Performance Tuning and Best Practice
This section shows the best practices to optimize the performance.
Chunk Size
When pushing CIs from UCMDB to Asset Manager, the Generic Adapter framework retrieves data from a
TQL query. The CIs are loaded in a chunk with respect to the chunk size setting. Adjusting the chunk size
has impact on the performance of data push. By default, the AM Generic Adapter chunk size for push is
4000. You can adjust it by changing the replication.chunk.size setting on the AM Generic Adapter.
To reduce the communication between adapter and UCMDB server, you may increase the chunk size.
To avoid task timeout, you may decrease the chunk size.
Time out
There are some global settings of timeout which affect AM Generic Adapter integration jobs. The
following figure shows a screenshot of the relevant timeout settings.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 211 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
TQL Tailoring
The CI to be pushed depends on the TQL's conditions and structure. Out-of-box TQLs are designed for
out-of-box mappings. If you do not need CI data, for example, the pushed data is for the use of SAM
software counter calculation, you can tailor TQL conditions to filter out unrequired data to speed up the
push job.
Here are some best practices in tailoring TQL queries.
l
Separate Node TQL by sub CI Type, for example, Unix and Windows.
l
Separate Node TQL by logical prefix computer name, for example, Name like XXX%.
l
Add CPU relation in Host and VM TQL, in order to only push those Host with specific CPU model.
l
To avoid pushing CIs which data is incomplete because some UD discover jobs are not completed,
add conditions to query only the CIs which required attributes are complete. For example, a condition
with Create time Unchanged during hours.
Push Mapping Simplification
The Host Server and VM relation push can be very slow for a high volume of CIs. If you do not need to see
the records in the amClientResource table, the Host Server and VM relation mapping can be simplified
to only link the host and its VM in AM and do not create client resource and business service.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 212 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Global ID
Turn on UCMDB Global ID
Global ID is the recommended reconciliation key for both push and population. It is more reliable and
takes less time to reconcile CIs/Assets in the target system.
Configure Push Back ID in population mapping
When IT equipment is populated from AM to UCMDB, it allows AM to save CI's global Id. The global Id will
be used in all future population, which helps UCMDB to identify a CI faster than populate CI without
global Id.
Replace Global ID reconciliation by normal attributes
The adapter engine can save pushed CI's external ID, for example, a node CI can save amComputer
lComputerId in cache. When the push relation is between the node and other CIs, you can use groovy
function AMPush.getAMPrimaryID to get the external ID from the pushed node.
The out-of-box push reconciliation design uses external ID for link relation in AM.
Due to issues in the underlying engine, the external ID might become out-of-date or may refer to the
incorrect AM objects. In this case, you can use normal attributes reconciliation to reconcile in AM record.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 213 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Population Mapping Optimization
AM Generic Adapter population allows populating multiple AM entities and relationship in one mapping
file. In practice, we recommend that you map one AM entity in a single data mapping.
For example, you can create a population mapping to convert Node, Location, and Interface to UCMDB.
However, it is better to split the mapping to three separate mappings to convert Node, Location, and
Interface respectively. In this way, Location should be populated first, then Node, Interface should be
populated at last. In the mapping for Node, you need to map the link to Location so that the relation
between Node and Location can be created in UCMDB.
We strongly recommend that you only reference Node's Global Id in the Interface population mapping.
This will improve reconciliation performance for UCMDB server. In order to use global Id for Node, you
must enable the Push Back Id in the Integration point configuration, and also need to configure AM_
PUSHBACK_ID in Node population mapping.
Migration Guide
This section describes how to perform a migration.
Differences between Old Push Adapter and Push in Generic
Adapter
The Generic Adapter framework is an extension to the Enhanced Generic Push Adapter framework to
support bi-direction data transformation between UCMDB and external systems. The AM Generic
Adapter is built on top of the Generic Adapter framework, thus it supports most of the features of the
old AM Push Adapter.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 214 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
To migrate from the old AM Push Adapter to the new AM Generic Adapter, you need to be aware of the
following changes.
Mapping Schema Changes
Data Push uses the existing Enhanced Generic Push Adapter framework with minor XML schema
changes. Please see Achieving Data Push using the Generic Adapter chapter in HP Universal CMDB
Developer Reference Guide.
File Renaming and reorganizing
l
TQL names
l
Mapping file names
l
am-push-mapping.xml is renamed to am-push-config.file
l
AMPushFunctions.groovy is renamed to AMPush.groovy
l
AMReconciliationAdvanced.groovy is renamed to AMReconcil.groovy
l
Some of the functions in AMPushFunctions.groovy are moved to AMUtils.groovy
Asset Manager Entity Reference in Mapping Script and
Reconciliation
It is a big change for involving AM entity in both push mappings and reconciliation files.
In old push mapping, name of target_ci_type is specified ci-type of am-mapping in reconciliation file.
In new push mapping, name of target_ci_type is AM entity name or sub link name of AM entity. This
change is intended to add attributes into mapping file use Mapping UI.
Type of target_ci_type in mapping file is the new attribute to be used in reconciliation file.
For more information, see "Define Reconciliation Rule for Target AM Entity in Push" on page 165.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 215 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Differences between Old Population Adapter and
Population in AM Generic Adapter
The old population adapter is implemented based on Generic Database Adapter, it is quite different and
incompatible with the AM Generic Adapter.
The following sections describe some of the major differences between them.
No need to import views for AM database
New AM Generic Adapter retrieves data by AM API, not like old population adapter that connects to
database directly. Therefore, the Generic Adapter does not need to import views any more, it
communicates with AM database through AM Entity.
Population mapping needs to specify TQL
The old populate adapter mapping uses ORM.xml, it does not rely on any dedicated TQL. Instead, it
retrieves data from AM database via OR mapping, according to each CI and relation.
The new population retrieves data from AM Entity through population mapping, and then synchronizes
data to UCMDB by specifying TQL.
AM Entity -> Population Mapping -> TQL
ORM mapping is separated to several population mappings by CI and relation:
Attributes conversion and discrimination
The AM Generic Adapter supports complex groovy syntax to implement attributes conversion and
discrimination logic. It does not need to configure lots of properties and xml files. Two examples are
shown as follows.
discriminator.properties
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 216 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Its contents can be replaced by AMPopulate.groovy, see hostDataCIList.
node_role.properties
Its contents can be replaced by AMPopulate.groovy, see nodeRoles.
Frequently Asked Questions
What is a Root CI node?
A Root node is a TQL node that represents the CI type that is created via the push to Asset Manager
from the TQL Structures. Usually the rest of the TQL structure contains information that can be
incorporated within the Root CI type and is used to enrich the record in Asset Manager. The Root is the
heart of the Composite CI (or Instance), and if it is deleted from UCMDB we send a delete notification to
Asset Manager for the entire record.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 217 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
When is a new Asset created in Asset Manager?
In the out of the box integration we create Assets for 4 types of UCMDB CIs:
l
Nodes
l
Business Elements
l
Printers
l
Display Monitors
Whenever UCMDB sends a CI of one of these types, the integration first tries to detect if this Asset
already exists in Asset Manager, using the defined reconciliation rules. If a matching Asset is found, it is
updated, otherwise a new Asset is created.
How do I control the action taken when a CI is deleted in UCMDB?
See "Action on Delete" on page 180.
I deleted a Node CI in UCMDB - Why isn’t it deleted in Asset Manager?
The default Action on Delete for nodes in the integration is to do nothing.
You may either change the action to delete the Asset in Asset Manager by changing the
<action-on-delete> xml mapping in the am-push-mapping.xml:
<am-mapping ci-type="amComputer" …>
…
…
<action-on-delete>
<delete-ci/>
</action-on-delete>
</am-mapping>
Or you may change the action to set the Asset as Missing in Asset Manager by changing the <action-ondelete> xml mapping in the am-push-mapping.xml:
<am-mapping ci-type="amComputer" …>
…
…
<action-on-delete>
<set-attribute-value name="Portfolio.seAssignment" datatype="INTEGER"
value="6"/>
</action-on-delete>
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 218 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
</am-mapping>
Validate that the Allow Delete check box in the job configuration is selected.
I deleted an Installed Software CI in UCMDB - Why isn’t it deleted in Asset Manager?
The default Action on delete for Installed Software in the integration is to mark it as missing.
You may change the action to delete the Soft Installed in Asset Manager, by changing the
<action-on-delete> xml mapping in the am-push-mapping.xml:
<am-mapping ci-type="Complete_amSoftInstall" …>
…
…
<action-on-delete>
<delete-ci/>
</action-on-delete>
</am-mapping>
Due to the complexity and amount of flows available for Installed Software you must also change these
mappings to match:
l
SW_amSoftInstall
l
Complete_amSoftInstall_User
l
soft_Hyper_amSoftInstall
l
SW_amSoftInstall_User
Is it possible to avoid overwriting an attribute in Asset Manager?
Yes. By using the Attribute Reconciliation feature, you choose to never overwrite an existing value.
Example:
<attribute-reconciliation attribute-name="AssetTag" update-script=
"mappings.scripts.AMPushFunctions.fIsEmpty(vOldVal) ? vNewVal : vOldVal"/>
See "Attribute Reconciliation" on page 179.
What is the different between the mapping XMLs and the am-push-mapping.xml?
The Mapping XMLs (for example: pushMappingAMBusinessElement.xml) define the way we convert the
data from the UCMDB data model into the Asset Manager Data Model and are executed by the Push
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 219 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Adapter.
For more information, see Developing Push Adapters in the HP Universal CMDB Developer Reference
Guide.
The am-push-mapping.xml is the Asset Manager Connector configuration file. It configures the way we
reconcile and handle the data, before we update Asset Manager with the record.
Should I select the ‘Enable Parallel' Feature?
Asset Manager configured over an Oracle database supports parallel push out of the box.
Asset Manager configured over an SQL Server database, needs some tuning before enabling this
capability. See "Prepare Asset Manager for Parallel Push" on page 128.
Why does an integration point that synchronizes only the AM Installed Software
Push TQL query, keep failing?
The AM Installed Software Push TQL query contains both a query node of Installed Software and a query
node of Node. The Node in this mapping is only referenced, and is mapped to Asset Manager by saving
its Asset Manager ID from an earlier run. Before pushing this TQL query, the same integration point
must push the Node to Asset Manager (using the AM Computer Push TQL).
How can I push nodes without Model Name or Serial Number information, to Asset
Manager?
To avoid pushing nodes not yet fully discovered, we avoid sending ones without a Model Name or Serial
Number that provide us with a physical identification of the Asset. If you would like to push these nodes
as well, simply remove the appropriate condition of the node from the AM Computer Push TQL query.
However removing the Node Role condition (filtering nodes without a Node Role) from the TQL query is
not recommended, as the integration will not know what type of an Asset/Portfolio to create in Asset
Manager.
What should I do before running Cluster mapping job?
If you want to push Cluster CIs to AM 9.41, you need to complete the following steps to add the
ITCLUSTER nature in AM manually.
1. Log on to Asset Manager as an administrator.
2. Go to Portfolio management > Asset configurations > Natures.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 220 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
3. Check if there is a nature with Code of value "ITCLUSTER".
4. If it does not exist, click the New button to create it with the following values.
Name="Cluster"
Code="ITCLUSTER"
Create=Portfolio item
Also create = Cluster(amCluster)
Management constraint = Unique asset tag
Has software installed = checked
Business service =checked
5. Click the Create button to save the new nature record.
Troubleshooting and Limitations
l
Limitation: A single probe may only connect to one version of Asset Manager. (Use of multiple
instances of the same version is supported). This is due to the JVM limitation of loading only one
Asset Manager API per process.
l
Limitation: The Data Flow Probe or Integration Service must be installed on a Windows OS.
l
Limitation: DB2 parallel push mode is not supported in UCMDB 10.01.
l
Problem: Missing DDLs or jars.
When testing the connection of the integration point, an error with the following phrase appears:
Asset Manager DLLs and/or Jars are missing
Solution: See "Deploy Asset Manager API Zip Package" on page 130.
l
Problem: First time synchronization has many failed CIs.
The first synchronization in the integration creates a large number of enum values in the Asset
Manager database. In some cases, when enabling the parallel push for the first synchronization, it
may cause a very large number of deadlocks during the push that is more than the Adapter’s auto
deadlock handling mechanism can handle.
Solution 1: You may try to re-synchronize the failed CIs until they all pass.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 221 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Solution 2: Add the enum attribute that caused the duplicate key exception to am-mapping in the
am-push-mapping.xml.
l
Problem: A push integration fails with the error message 'Only one connected Asset CI is
allowed'
When running a push integration of Computers to Asset Manager, one of the reconciliation
attributes used is Asset Tag. If there is more then one Asset CI connected to the Node CI, it means
there is more then one Asset Tag for a single Node; this is not a valid state.
Solution: Remove the CIT Computer from the incorrect Asset CIs. This should ensure the Node is
connected to either one or no Asset CIs.
l
Problem: Some CIs in a Relations Push fail.
The Relations flow (TQL query) assumes that you schedule (either in the same job, or in a different
job) the different flows that this Relations push depends on, to run before this flow. For more
information, see "Asset Manager Push Jobs" on page 136.
l
Problem: Some CIs in a Software Push fail.
The software flows assume that you schedule the computer push flow (either in the same job, or in a
different job) to run first. See"Frequently Asked Questions" on page 217 .
l
Problem: Missing Root in a TQL Query.
Solution: The integration TQL query must contain a Root Element (1 if it is a CI, 1 or more if it is a
Relationship). Update your TQL query by renaming one of the query Elements to Root. Make sure
your mapping xml is updated accordingly.
See "Frequently Asked Questions" on page 217.
l
Problem: Error in Test Connection. Unable to connect to this database engine.
The following solution assumes you are connecting to a DB2 or Oracle database.
Solution: Validate the following:
1. The database client is installed on the Data Flow Probe/Integration Service machine. See "Install
a Database Client" on page 130.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 222 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
2. The installed client is a 64 bit version.
3. The client is installed on the actual Probe selected in the integration point configuration.
l
Problem: Multiple Assets are created in Asset Manager for a single UCMDB Node.
Solution 1: This can happen when the maximum length of an attribute is too short compared to the
attribute's value in UCMDB. It causes the attribute value to truncate when pushed to Asset Manager.
However, on a different execution, when attempting to reconcile the attribute, there will not be a
match because of the truncated value in asset Manager. Therefore, increase the attribute length.
See "Update Asset Manager Schema" on page 127.
Solution 2: Check and fix customized or changed reconciliation rules.
l
Problem: Error in test connection: Module Ssl : Unable to load dynamic library (libeay64.dll).
This error occurs when the Windows operating system of the probe is missing the Visual C++ 2008
SP1 or later.
Solution 1: Download and install the Microsoft Visual C++ 2008 SP1 Redistributable Package (x64).
You may download this from:
http://www.microsoft.com/download/en/details.aspx?id=2092.
Thereafter, reboot Windows and restart the Probe.
Solution 2: Run Windows update and retrieve the Visual C++ 2008 SP1 or later update. Thereafter,
reboot Windows and restart the Probe.
l
Problem: The number of the virtual CPUs is pushed into AM
Some customers may tailor UD, add virtual CPUs as physical CPU CI, and then set the Is Virtual
attribute to True. In this situation, the push adapter will count the number of both virtual and
physical CPUs to set the fCPUNumber field in AM.
Solution 1: To avoid counting virtual CPU in AM, add the Is Virtual = False condition in AM
Computer/Node Push TQL.
Solution 2: Create a groovy function (for example, getPhysicalCoreCount) to count the CPU CIs
whose Is Virtual is False.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 223 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
Logs
AM API Logs
The generic adapter framework uses a different logs then the normal fcmdb.adapters.*.log files.
To change the level of the log files to debug, edit the following file:
l
On the Data Flow Probe machine:
..\DataFlowProbe\conf\log\fcmdb.push.properties
l
If using the integration service, on the UCMDB server:
..\UCMDB Server\Integrations\conf\log\fcmdb.push.properties
Change the log level to DEBUG:
loglevel=DEBUG
The integration generates fcmdb.push.* logs in the following folder:
l
On the Data Flow Probe machine:
..\DataFlowProbe\runtime\log\
l
If using the integration service, on the UCMDB server:
..\UCMDB Server\Integrations\runtime\log\
AM API Logs
The AM Generic Adapter uses the AM native APIs to communicate with the AM database. You can turn on
the AM API log to trace the calls invoked to the AM native APIs and SQL queries issued to the AM
database.
The following steps are used to configure the AM API log for the AM Generic Adapter.
1. On the computer that hosts the Data Probe server, find the Windows account to run the uCMDB
Probe service.
2. If the account is Local System, perform the next actions in the directory.
“C:\Windows\System32\config\systemprofile\AppData\Roaming\HP\AssetManager\conf”.
Otherwise, do it in the directory “<user profile dir>\AppData\Roaming\HP\AssetManager\conf”,
where <user profile dir> is the profile directory of the user who runs the uCMDB Probe service.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 224 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 4: HP Asset Manager Integration with the AM Generic Adapter
3. In the directory, locate the aamapixx.ini file where ‘xx’ represents the AM version, e.g. aamapi94.ini
for AM 9.4x. Create the file if it does not exist.
4. Add the following lines to the file.
[Option]
/AdbLog/LogApiCalls=1
/AdbLog/AdbLogStartup=1
/AdbLog/AdbLogFileName=c:\temp\am-generic-adapter.log
/AdbLog/AdbLogFileSize=100000000
/Advanced/TraceLDAP=1
5. Restart the uCMDB Probe server.
6. After running an integration job, the file is created in the location you specify in the
AdbLogFileName property.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 225 of 366
Chapter 5: HP Configuration Manager Federating KPI Data
This chapter includes:
Overview
227
How to Consume Federated KPI Data from Configuration Manager
228
Troubleshooting and Limitations
231
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 226 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 5: HP Configuration Manager - Federating KPI Data
Overview
The federation mechanism that is built into HP Universal CMDB enables UCMDB to be used as a contact
repository for sharing data among external applications, without duplicating it. By federating data from
Configuration Manager to UCMDB, external applications can consume its analysis information in various
ways:
l
Use UCMDB's reporting functionality to generate and schedule reports on top of Configuration
Manager's data.
l
Consume Configuration Manager's data in other HP applications, such as HP Business Service
Management.
l
Use Configuration Manager's analysis data as a basis for making decisions in other applications.
Configuration Manager exposes the following data for federation:
l
Policy compliance status data includes information about current policy result data for managed
CIs and the associated policies.
l
Authorization status data includes information about the authorization status of managed CIs.
UCMDB provides the class model for the schema for the model to be shared, and uses a federation TQL
query as the way to consume data in UCMDB on the fly. For details, see "Federating KPIs" in the HP
Universal CMDB Configuration Manager User Guide.
KPI means Key Performance Indicator. The UCMDB provides the CMKpiAdapter to federate KPI
information about policy and authorization status from Configuration Manager. The data that is
federated from Configuration Manager populates the Kpi and KpiObjective CITs, and can be retrieved
by TQL as described in "Create KPI Reports" on page 229.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 227 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 5: HP Configuration Manager - Federating KPI Data
How to Consume Federated KPI Data from
Configuration Manager
This workflow provides a brief overview of the steps to be performed in UCMDB, in order to consume
federated KPI data from Configuration Manager.
This task includes the following steps:
l
"Create an Integration Point to Federate KPI Data" below
l
"Create KPI Reports" on the next page
Create an Integration Point to Federate KPI Data
1. In the Integration Studio, create a new integration point.
2. Set the following adapter properties:
Field
Description
Adapter
Click the
Credentials ID
button and select CMKpiAdapter.
Do the following:
a. Click the
button.
b. Select Generic Protocol and click OK.
c. Click the
button to add the credentials to connect to the
Configuration Manager database. Enter credentials for the user who
has Manage, Authorize, and Access to UI permissions.
d. When finished, click OK.
Hostname/IP
Provide the host name or IP address of the Configuration Manager
database.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 228 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 5: HP Configuration Manager - Federating KPI Data
Field
Description
Integration Name
Enter a name for the new integration point.
Port
Enter the port number that is used for communication with the
Configuration Manager database.
Use SSL
Select False. You cannot use secured communication to federate data
from Configuration Manager.
3. Click Test Connection to make sure that you have configured the integration point correctly.
4. Click OK to save the integration point.
5. Select the KPI and KPIObjective CI types in the Supported and Selected CI Types tree.
6. Click the
button to save the integration point.
For further details about creating integration points, see the section about the Integration Studio in the
HP Universal CMDB Data Flow Management Guide.
Create KPI Reports
You can create KPI reports based on the CIs in a view, a custom TQL query, or business services.
1. In UCMDB, create a new view based on a custom TQL or copy an existing view.
Note: When using a custom TQL query, make sure you take into account the limitations of the
data capacity when using federation. You should filter the CIs in the TQL query to take this
limitation into account. For details, see .
2. For each configuration item that you want to associate with a policy, attach the selected CI to the
Kpi CI type and the Kpi CI type to the KpiObjective CI type, using composition links. The cardinality
should be 0..* if you also want to obtain results for CIs that do not have associated KPI information.
Note: If you want to create a business services report, select the BusinessService CI type when
creating the TQL query.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 229 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 5: HP Configuration Manager - Federating KPI Data
3. Specify the Configuration Manager integration point that you defined to be the data source that
provides the policy and policy result data.
4. Set the hierarchy. An example is shown below:
5. Add properties for the KpiObjective CI type to the report layout: An example is shown below:
6. If desired, you can schedule these reports to be created periodically. For details, see the HP
Universal CMDB Data Flow Management Guide.
For details about creating reports, see the section about reports in the HP Universal CMDB Modeling
Guide.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 230 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 5: HP Configuration Manager - Federating KPI Data
Troubleshooting and Limitations
l
Federation only works with CIs in the actual state. Therefore:
o
Policy compliance is federated only for CIs in the actual state.
o
The authorization status for CIs that were deleted from the actual state is not shown.
l
SSL communication for KPI data federation is not supported.
l
The maximum number of CIs that can be federated is configurable. For details about changing this
number, edit the value of the Max Num To Federate setting in the Infrastructure Settings Manager
in UCMDB. For details about changing settings, see the Infrastructure Settings Manager chapter in
the HP Universal CMDB Administration Guide. The recommended number of CIs is no more than
20,000, if large views have been enabled in Configuration Manager. For details about enabling
support for large views, see the section describing large capacity planning in the interactive HP
Universal CMDB Deployment Guide.
l
If the test connection fails, click Details and check the first error in the stack trace for more
information.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 231 of 366
Chapter 6: HP Configuration Manager Federating Policy Data
This chapter includes:
Overview
233
How to Consume Federated Policy Data from Configuration Manager
234
Troubleshooting and Limitations
239
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 232 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 6: HP Configuration Manager - Federating Policy Data
Overview
The federation mechanism that is built into HP Universal CMDB enables UCMDB to be used as a contact
repository for sharing data among external applications, without duplicating it. By federating data from
Configuration Manager to UCMDB, external applications can consume its analysis information in various
ways:
l
Use UCMDB's reporting functionality to generate and schedule reports on top of Configuration
Manager's data.
l
Consume Configuration Manager's data in other HP applications, such as HP Business Service
Management.
l
Use Configuration Manager's analysis data as a basis for making decisions in other applications.
Configuration Manager exposes Policy compliance status data (which includes information about
current policy result data for managed CIs and the associated policies) for federation.
UCMDB provides the class model for the schema for the model to be shared, and uses a federation TQL
query as the way to consume data in UCMDB on the fly. For details, see "Federating Policy Compliance
Data" in the HP Universal CMDB Configuration Manager User Guide.
UCMDB provides the CMPolicyAdapter to federate policy data from Configuration Manager, which
populates the Policy and PolicyResult CITs, and can be retrieved by TQL as described in "Create Policy
Reports Based on CIs in a View or Custom TQL query" on page 235 and "Create summary policy reports
based on the CIs in a view or a custom TQL query" on page 237.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 233 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 6: HP Configuration Manager - Federating Policy Data
How to Consume Federated Policy Data from
Configuration Manager
This workflow provides a brief overview of the steps to be performed in UCMDB, in order to consume
federated data from Configuration Manager.
This task includes the following steps:
l
"Create an Integration Point to Federate Policy Compliance Data" below
l
"Create Policy Reports Based on CIs in a View or Custom TQL query" on the next page
l
"Create summary policy reports based on the CIs in a view or a custom TQL query" on page 237
Create an Integration Point to Federate Policy Compliance Data
1. In the Integration Studio, create a new integration point.
2. Set the following adapter properties:
Field
Description
Adapter
Click the
Credentials ID
button and select CMPolicyAdapter.
Do the following:
a. Click the
button.
b. Select Generic DB Protocol (SQL) and click OK.
c. Click the
button to add the credentials to connect to the
Configuration Manager database. These should be the same
credentials that were provided during the installation of
Configuration Manager.
d. When finished, click OK.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 234 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 6: HP Configuration Manager - Federating Policy Data
Field
Description
DB Name/SID
The database name or schema ID.
DB Type
Specify Oracle or MSSQL, as required.
Hostname/IP
Provide the host name or IP address of the Configuration Manager
database.
Integration Name
Enter a name for the new integration point.
Port
Enter the port number that is used for communication with the
Configuration Manager database.
3. Click Test Connection to make sure that you have configured the integration point correctly.
4. Click OK to save the integration point.
5. Select the Policy and PolicyResults CI types in the Supported and Selected CI Types tree.
6. Click the
button to save the integration point.
For further details about creating integration points, see the section about the Integration Studio in the
HP Universal CMDB Data Flow Management Guide.
Create Policy Reports Based on CIs in a View or Custom TQL query
1. Create an integration point as described in , if one does not already exist.
2. In UCMDB, create a new view with a custom TQL query, or copy an existing view.
Note: When using a custom TQL query, make sure you take into account the limitations of the
data capacity when using federation. You should filter the CIs in the TQL query to take this
limitation into account. For details, see
3. For each configuration item that you want to associate with a policy, attach the Policy CI type and
the selected CI to the PolicyResult CI type, using composition and aggregation links accordingly.
The cardinality should be 0..* if you also want to obtain results for CIs that do not have associated
policy information. An example is shown below:
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 235 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 6: HP Configuration Manager - Federating Policy Data
4. Specify the Configuration Manager integration point that you defined to be the data source that
provides the policy and policy result data.
5. Set the hierarchy. An example is shown below:
6. Add properties for the Policy CI type to the report layout: An example is shown below:
7. Add properties for the PolicyResult CI type to the report layout. An example is shown below:
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 236 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 6: HP Configuration Manager - Federating Policy Data
8. If desired, you can schedule these reports to be created periodically. For details, see the HP
Universal CMDB Data Flow Management Guide.
For details about creating reports, see the section about reports in the HP Universal CMDB Modeling
Guide.
Create summary policy reports based on the CIs in a view or a custom TQL query
1. Create an integration point as described in , if one does not already exist.
2. In UCMDB, create a new view or copy an existing view.
Note: When using a custom TQL query, make sure you take into account the limitations of the
data capacity when using federation. You should filter the CIs in the TQL query to take this
limitation into account. For details, see .
3. For each configuration item that you want to associate with a policy, attach the Policy CI type and
the selected CI to the PolicyResult CI type, using composition and aggregation links accordingly.
The cardinality should be 0..* if you also want to obtain results for CIs that do not have associated
policy information. An example is shown below:
4. Specify the Configuration Manager integration point that you defined to be the data source that
provides the policy and policy result data.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 237 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 6: HP Configuration Manager - Federating Policy Data
5. Set the hierarchy. An example is shown below:
6. Create an aggregation function for the Policy CI type. An example is shown below:
7. Add properties for the Policy CI type to the report layout. An example is shown below:
8. Add properties for the ConfigurationItem CI type to the report layout. An example is shown below:
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 238 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 6: HP Configuration Manager - Federating Policy Data
9. Change the report format to a bar chart. An example is shown below:
10. If desired, you can schedule these reports to be created periodically. For details, see HP Universal
CMDB Data Flow Management Guide.
For details about creating reports, see the section about reports in the HP Universal CMDB Modeling
Guide.
Troubleshooting and Limitations
l
l
Federation only works with CIs in the actual state. Therefore:
o
Policy compliance is federated only for CIs in the actual state.
o
The authorization status for CIs that were deleted from the actual state is not shown.
The maximum number of CIs that can be federated is configurable. For details about changing this
number, edit the value of the Max Num To Federate setting in the Infrastructure Settings Manager
in UCMDB. For details about changing settings, see the Infrastructure Settings Manager chapter in
the HP Universal CMDB Administration Guide. The recommended number of CIs is no more than
20,000, if large views have been enabled in Configuration Manager. For details about enabling
support for large views, see the section describing large capacity planning in the HP Universal CMDB
Configuration Manager Deployment Guide.
l
If the test connection fails, click Details and check the first error in the stack trace for more
information.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 239 of 366
Chapter 7: HP Discovery and Dependency
Mapping Inventory Integration
This chapter includes:
Overview
241
Supported Versions
241
DDMI Adapter
241
How to Populate the CMDB with Data from DDMI
243
How to Federate Data with DDMI
245
How to Customize the Integration Data Model in UCMDB
245
Predefined Queries for Population Jobs
247
DDMI Adapter Configuration Files
247
Troubleshooting and Limitations
248
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 240 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 7: HP Discovery and Dependency Mapping Inventory Integration
Overview
This document describes how to integrate Discovery and Dependency Mapping Inventory (DDMI) with
UCMDB. Integration occurs by populating the UCMDB database with devices, topology, and hierarchy
from DDMI and by federation with DDMI's supported classes and attributes. This enables change
management and impact analysis across all business services mapped in UCMDB.
According to UCMDB reconciliation rules, if a CI is mapped to another CI in the CMDB, it is updated during
reconciliation; otherwise, it is added to the CMDB.
Supported Versions
DDMI integration has been developed and tested on HP Universal CMDB version 7.5.2 or later with ED
version 2.20 or DDMI version 7.5.
DDMI Adapter
Integration with DDMI is performed using a DDMI adapter, which is based on the Generic DB Adapter.
This adapter supports full and differential population for defined CI types as well as federation for other
CI types or attributes.
The DDMI adapter supports the following features:
l
Full population of all instances of the selected CI types.
l
Identifying changes that have occurred in DDMI, to update them in UCMDB.
l
Implementing Remove in DDMI. When a CI is removed in DDMI, it is not physically deleted from the
database, but its status is changed to indicate that the CI is no longer valid. The DDMI adapter
interprets this status as an instruction to remove the CI when needed.
l
Federation of defined CI types and attributes.
Out-of-the-box integration with DDMI includes population of the following classes:
l
Node (some of the attributes are populated and some are federated)
l
Layer2 connection
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 241 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 7: HP Discovery and Dependency Mapping Inventory Integration
l
Location that is connected to the node
l
IP address
l
Interface
In addition, the following classes can be defined as federated from DDMI:
l
Asset
l
CPU
l
File system
l
Installed software
l
Printer
l
Cost center
The following classes and attributes should be marked as federated by the DDMI adapter for the proper
functionality of the Actual State feature of Service Manager:
l
l
Classes
o
Person
o
Asset
o
CPU
o
Installed software
o
Printer
o
Windows service
Node attributes
o
DiscoveredOsVendor
o
DiscoveredModel
o
Description
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 242 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 7: HP Discovery and Dependency Mapping Inventory Integration
o
DomainName
o
DiscoveredLocation
o
NetBiosName
Note: Avoid marking the CreateTime and LastModifiedTime attributes as federated, as it may lead
to unexpected results.
How to Populate the CMDB with Data from DDMI
This task describes how to install and use the DDMI adapter, and includes the following steps:
l
"Define the DDMI integration" below
l
"Define a population job (optional)" on the next page
l
"Run the population job" on the next page
1.
Define the DDMI integration
a. In UCMDB, navigate to Data Flow Management > Integration Studio.
b. Click the new integration point
l
Click
button to open the new integration point Dialog Box.
, select the DDMI adapter, and click OK.
Each out-of-the-box adapter comes predefined with the basic setup needed to perform
integration with UCMDB. For information about changing these settings, see "Integration
Studio Page" in the HP Universal CMDB Data Flow Management Guide.
l
Enter the following information, and click OK:
Name
Description
Credentials
Allows you to set credentials for integration points. For credential
information, see "Supported Protocols" in the HP Universal CMDB Discovery
and Integration Content Guide - Supported Content document.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 243 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 7: HP Discovery and Dependency Mapping Inventory Integration
Name
Description
Hostname/IP The name of the DDMI server.
Integration
Name
The name you give to the integration point.
Is
Integration
Activated
Select this check box to create an active integration point. You clear the
Port
The port through which you access the DDMI database.
check box if you want to deactivate an integration, for instance, to set up
an integration point without actually connecting to a remote machine.
c. Click Test connection to verify the connectivity, and click OK.
d. Click Next and verify that the following message is displayed: A connection has been
successfully created. If it does not, check the integration point parameters and try again.
2.
Define a population job (optional)
The DDMI adapter comes out-of-the-box with the DDMI Population job, which runs the following
predefined queries: hostDataImport, networkDataImport, printerDataImport, and
Layer2DataImport. For details about these queries, see "Predefined Queries for Population Jobs"
on page 247. This job runs according to a default schedule setting.
You can also create additional jobs. To do this, select the Population tab to define a population job
that uses the integration point you defined in "Define the DDMI integration" on the previous page.
For details, see "New Integration Job/Edit Integration Job Dialog Box" in the HP Universal CMDB Data
Flow Management Guide.
3.
Run the population job
Activate the population job in one of the following ways:
o
To immediately run a full population job, click
. In a full population job, all appropriate data is
transferred, without taking the last run of the population job into consideration.
o
To immediately run a differential population job, click
. In a differential population job, the
previous population time stamp is sent to DDMI, and DDMI returns changes from that time
stamp to the present. These changes are then entered into the UCMDB database.
o
To schedule a differential population job to run at a later time or periodically, define a
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 244 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 7: HP Discovery and Dependency Mapping Inventory Integration
scheduled task. For details, see "Define Tasks that Are Activated on a Periodic Basis" in the HP
Universal CMDB Administration Guide.
How to Federate Data with DDMI
The following steps describe how to define the CI types that will be federated with DDMI.
1. In UCMDB, navigate to Data Flow Management > Integration Studio.
2. Select the integration point that you defined in "Define the DDMI integration" on page 243.
3. Click the Federation tab. The panel shows the CI types that are supported by the DDMI adapter.
4. Select the CI types and attributes that you want to federate.
5. Click Save
.
How to Customize the Integration Data Model in
UCMDB
Out-of-the-box CIs for DDMI integration can be extended in one of the following ways:
To add an attribute to an existing CI type:
If the attribute you want to add does not already exist in the CMDB, you need to add it. For details, see
"Add/Edit Attribute Dialog Box" in the HP Universal CMDB Modeling Guide.
1. Go to the orm.xml file as follows: Data Flow Management > Adapter Management >
DDMiAdapter > Configuration Files > orm.xml.
2. Locate the generic_db_adapter.[CI type] to be changed, and add the new attribute.
3. Ensure that the TQL queries that include this CI Type have the new attribute in their layouts, as
follows:
a. In the Modeling Studio, right-click the node where you want to include the attribute.
b. Select Query Node Properties.
c. Click Advanced layout settings and select the new attribute.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 245 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 7: HP Discovery and Dependency Mapping Inventory Integration
For details about selecting attributes, see "Layout Settings Dialog Box" in the HP Universal CMDB
Modeling Guide. For limitations on creating this TQL query, see "Troubleshooting and Limitations"
on page 248
To add a new CI type to the DDMI Adapter:
1. In UCMDB, create the CI type that you want to add to the adapter, if it does not already exist. For
details, see "Create a CI Type" in the HP Universal CMDB Modeling Guide.
2. Go to the orm.xml file as follows: Data Flow Management > Adapter Management >
DDMiAdapter > Configuration Files > orm.xml.
3. Map the new CI type by adding a new entity called generic_db_adapter.[CI type].
4. In the orm.xml file, ensure that the new CI type has the following mappings:
a. the data_note attribute is mapped to the NMID_StatusInAppliance column (this attribute is
used for checking the CI's status).
b. the last_modified_time and create_time attributes are mapped to the Device_UpdatedDt
and Device_FirstFoundDt columns.
For details, see "The orm.xml File" in the HP Universal CMDB Developer Reference Guide.
5. Create queries to support the new CI types that you added. Make sure that all mapped attributes
have been selected in the Advanced Layout settings:
a. In the Modeling Studio, right-click the node where you want to include the attribute.
b. Select Query Node Properties.
c. Click Advanced layout settings and select the new attribute.
For details about selecting attributes, see "Layout Settings Dialog Box" in the HP Universal CMDB
Modeling Guide. For limitations on creating this TQL query, see "Troubleshooting and Limitations"
on page 248.
6. In UCMDB, navigate to Data Flow Management > Integration Studio.
7. Edit the DDMI integration point to support the new CI type by selecting it either for population or
for federation.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 246 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 7: HP Discovery and Dependency Mapping Inventory Integration
8. If the new CI type is for population, edit the population job that you created in "Define a population
job (optional)" on page 244 to include the new TQL query.
Predefined Queries for Population Jobs
The following TQL queries (located in the Modeling Studio in the Integration\Data In folder) are provided
out-of-the-box if you use the DDMI adapter when you create an integration point:
l
hostDataImport - use to import nodes. Imported data includes nodes whose NodeRole attribute is
either null, or contains desktop, server, or virtualized_system. Nodes are identified either by their
interface or IP address. Information also includes the location of the nodes (building, floor and
room).
l
networkDataImport - use to import nodes that are not imported with hostDataImport. Similar to
hostDataImport, except that it imports nodes whose NodeRole is not null and does not contain the
following strings: desktop, server, virtualized_system, or printer.
l
printerDataImport - use to import printers. Similar to networkDataImport, except that it does
import nodes whose NodeRole contains the string printer.
l
Layer2DataImport - use to import Layer2 connections between pairs of nodes through their
interfaces. Information also includes the nodes and their IP addresses.
DDMI Adapter Configuration Files
The adapter includes the following configuration files:
l
orm.xml. The Object Relational mapping file in which you map between UCMDB classes and
database tables.
l
discriminator.properties. Maps each supported CI type (also used as a discriminator value in
orm.xml) to a list of possible corresponding values of the discriminator column, DeviceCategory_ID.
l
replication_config.txt. Contains a comma-separated list of non-root CI and relations types that
have a Remove status condition in the DDMI database. This status condition indicates that the
device has been marked for deletion.
l
fixed_values.txt. Includes a fixed value for the attribute ip_domain in the class IP (DefaultDomain).
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 247 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 7: HP Discovery and Dependency Mapping Inventory Integration
For details on adapter configuration, see "Developing Generic Database Adapters" in the HP Universal
CMDB Developer Reference Guide.
Troubleshooting and Limitations
Note: Only queries that meet these requirements are visible to the user when selecting a query for
a population job.
l
Queries that are used in population jobs should contain one CI type that is labeled with a Root prefix,
or one or more relations that are labeled with a Root prefix.
The root node is the main CI that is synchronized; the other nodes are the contained CIs of the main
CI. For example, when synchronizing the Node CI Type, that graph node is labeled as Root and the
resources are not labeled Root.
l
The TQL graph must not have cycles.
l
A query that is used to synchronize relations should have the cardinality 1...* and an OR condition
between the relations.
l
The adapter does not support compound relations.
l
The TQL graph should contain only CI types and relations that are supported by the DDMI adapter.
l
ID conditions on the integration TQL query are not supported.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 248 of 366
Chapter 8: HP IT Executive Scorecard
This chapter includes:
Overview
250
Supported Versions
250
How to Push Data from UCMDB to Executive Scorecard
250
Executive Scorecard Adapter
253
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 249 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 8: HP IT Executive Scorecard
Overview
HP Universal CMDB (UCMDB) is based on three key elements: a rich data model, visualization, and
federation to additional data repositories. UCMDB provides impact analysis, change tracking, and
reporting capabilities to transform UCMDB data into comprehensible, actionable information that helps
answer critical questions and solve business problems. UCMDB can provide valuable information about
services, and their operational status.
The purpose of the integration of UCMDB as a data source is to bring quality management information
into the Data Warehouse.
You use the UCMDB push adapter to access data links and nodes from UCMDB, which are then pushed
into the Data Warehouse. You must deploy the push adapter package when the UCMDB Content Pack is
activated in the Data Source Management UI, and before the first run of the ETL in order to get the
Node, Application and Services topology from UCMDB.
Supported Versions
UCMDB supports integration with Executive Scorecard version 9.31 or later.
How to Push Data from UCMDB to Executive Scorecard
1.
Prerequisite - Set up Executive Scorecard
Perform the steps "Activate the Integration" and "Connect to UCMDB on a Secured Connection" as
described in the Executive Scorecard manual Content Reference Guide for the Integration with HP
Universal Configuration Management Database.
2.
Prerequisite - Ensure that the push adapter package has been deployed
Note: If you have installed UCMDB version 10.10 or later with CP14, the push adapter package
is installed by default. You can skip this step.
a. In UCMDB, go to Data Flow Management > Adapter Management.
b. In the Resources pane, search for XSAdapter.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 250 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 8: HP IT Executive Scorecard
3.
Create an integration point
a. Complete the integration and adapter properties fields as shown in the following table:
Field
Required Description
Integration Properties
Integration
Yes
Enter a unique name for the integration point.
No
Enter a description of the current integration point.
Yes
Click the
Name
Integration
Description
Adapter
button and select HP BTO Products > Executive
Scorecard > Executive Scorecard.
Is
Yes
Select this check box to create an active integration point. You
Integration
clear the check box if you want to deactivate an integration, for
Activated
instance, to set up an integration point without actually
connecting to a remote machine.
Adapter Properties
Hostname/IP Yes
The hostname or IP Address of the Executive Scorecard
database.
Port
Yes
1433 (the communication port of the Executive Scorecard
database).
Database
Yes
The staging database name of the Data Warehouse in Executive
Scorecard.
Schema
Yes
dws (the name of the database schema).
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 251 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 8: HP IT Executive Scorecard
Field
Required Description
Credentials
Yes
Do the following:
ID
i. Click the
button.
ii. Select Generic DB Protocol (SQL) and click OK.
iii. Click the
button to add new credentials. Enter the
following information:
l
Database Type: Select Microsoft SQL Server.
l
Port Number: Leave the default value (1433).
l
Connection Timeout: Leave the default value (20000).
l
User Name and Password: Enter the user name and
password for connecting to the Executive Scorecard Data
Warehouse database.
iv. When finished, click OK.
Data Flow
Yes
Probe
The name of the Data Flow Probe on which the integration runs.
Select a Data Flow Probe whose range includes the IP address of
the Executive Scorecard database.
Additional
Probes
No
Select additional probes to use when pushing to AM in order to
increase redundancy.
For details about how to create an integration point, see "How to Set Up an Integration Point"
in the HP Universal CMDB Data Flow Management Guide.
b. Click OK.
c. Click Test Connection. If the connection fails, verify that the information provided is correct.
d. Click OK to close the dialog box and return to the Integration Studio.
4.
Edit the existing integration job (optional)
A default integration job called XS Push job is created when you create an integration point using
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 252 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 8: HP IT Executive Scorecard
the Executive Scorecard adapter. You can edit this job to change the default queries or the job's
schedule.
a. Select the integration point that you created in step 4 and click XS Push job.
b. Click
.
c. Update the TQL queries listed or schedule as required.
d. When you are finished, click OK.
5.
Run the job
a. In the Integration Studio, select the integration point that you created in step 4.
b. Select XS Push job and click
to run a full synchronization.
Executive Scorecard Adapter
This section contains information about the XSAdapter.
Input CIT
destination_config
Triggered CI Data
Name
Value
adapterId
${ADAPTER.adapter_id}
attributeValues
${SOURCE.attribute_values}
credentialsId
${SOURCE.credentials_id:FED#_NA}
destinationId
${SOURCE.destination_id}
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 253 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 8: HP IT Executive Scorecard
Parameters
Name
Value
credentialsId
database
host
port
schema
HP Universal CMDB (Content Pack 17.00 (CP17))
dws
Page 254 of 366
Chapter 9: HP Network Automation (NA)
Integration
This chapter includes:
Overview
256
Supported Versions
256
Topology
256
How to Pull Data Topology from an HP NA Server using a Java Client
257
Pull Topology from HP NA Adapter
260
Limitations
262
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 255 of 366
Overview
HP Network Automation (NA) provides an enterprise class solution that tracks and regulates
configuration and software changes across routers, switches, firewalls, load balancers, and wireless
access points. NA provides visibility into network changes, enabling the IT staff to identify and correct
trends that could lead to problems, while mitigating compliance issues, security hazards, and disaster
recovery risks. NA also captures full audit trail information about each device change.
Network engineers can use NA to pinpoint the following:
l
Which device configuration changed?
l
What exactly was changed in the configuration?
l
Who made the change?
l
Why the change was made?
In addition, NA can enforce security and regulatory policies at the network level by making sure that
configurations comply with pre-defined standards.
Supported Versions
This integration supports HP Network Automation (NA) 9.22, 10.00 and 10.10.
Topology
The diagram below depicts the HP NA topology.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 256 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 9: HP Network Automation (NA) Integration
How to Pull Data Topology from an HP NA Server
using a Java Client
The HP NA server provides the Java client library, which allows executing predefined commands and
retrieving topology data remotely. Communication is done over RMI in binary format.
This section describes how to pull topology data from the HP NA server to the UCMDB using a Java client.
Prerequisites
1. Ensure that there is connectivity to the HP NA server on the RMI port. The default port is 1099.
2. The user performing the connection must have the correct permissions to execute the list and
show commands.
Integration Flow
1. (This step is only for NA 10.10) To support NA 10.10, do the following:
a. Create a new folder na1010 under the <probe>\runtime\probeManager\discoveryResources
directory.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 257 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 9: HP Network Automation (NA) Integration
b. Copy the following two .jar files from the
<probe>\runtime\probeManager\discoveryResources\na directory to the
<probe>\runtime\probeManager\discoveryResources\na1010 directory:
l
ddm-na-client.jar
l
fst.jar
c. Copy the following NA 10.10 .jar files to the
<probe>\runtime\probeManager\discoveryResources\na1010 directory:
l
bcprov-jdk150on.jar, cryptojce.jar, cryptojcommon.jar, and jcmFIPS.jar in the <NA
Installation DIR>/jre/lib/ext directory.
l
truecontrol-client.jar in the <NA Installation DIR>/client directory.
l
json.jar in the <NA Installation DIR>/server/ext/jboss/server/default/lib directory.
d. Result
The <probe>\runtime\probeManager\discoveryResources\na1010 directory includes the
following files:
l
bcprov-jdk15on.jar
l
cryptojce.jar
l
cryptojcommon.jar
l
ddm-na-client.jar
l
fst.jar
l
jcmFIPS.jar
l
json.jar
l
truecontrol-client.jar
2. Create a new integration point in the Integration Studio based on the Pull topology from HP
Network Automation adapter as follows:
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 258 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 9: HP Network Automation (NA) Integration
a. In UCMDB, go to Data Flow Management > Integration Studio.
b. Click the New Integration Point
button. The New Integration Point dialog box opens.
c. Enter a name and description for the adapter.
d. Check the Is Integration Activated check box.
e. In the Adapter field, click the Select Adapter
button. The Select Adapter dialog box
opens.
f. Go to HP Software Products > HP Network Automation, select Pull Topology from HP Network
Automation, and click OK.
g. In the Adapter Properties section, define the following properties:
Note: Most of the properties listed below are assigned default values that are displayed
after selecting Pull Topology from HP Network Automation in the previous step.
l
Credentials ID. Click the Select Credentials ID
button and in the Choose Credentials
dialog box enter the HP NA Java protocol credentials to be used for connection.
l
queryTopologyPerDevice. This parameter affects how information about devices is
queried. When disabled, topology entities are retrieved in single queries. When enabled,
separate query is issued to retrieve data per device. The default value is false.
l
remoteJVMClasspath. This is the class path of the external JVM process. The default value
assigned here should not be changed.
Note: When integrating with NA 10.10, replace the value of the remoteJVMClasspath
with the following:
../runtime/probeManager/discoveryResources/na1010/*;%minimal_classpath%
l
reportDeviceConfigs. This parameter specifies whether the latest configuration of devices
should be reported as configuration_document CIs. The default value is false.
l
runInSeparateProcess. This parameter enables the job to run in an external JVM process,
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 259 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 9: HP Network Automation (NA) Integration
separate from the main probe process. The default value is true and this value should not
be changed.
l
Data Flow Probe. This parameter defines the Probe to be used for integration. Select
DataFlowProbe to explicitly choose the probe, or Auto-Select if you want the probe to be
automatically selected according to where the destination IP is assigned.
l
Trigger CI instance. This parameter defines the IP Address of the target HP NA server.
h. Click OK in the New Integration Point dialog box.
3. Run the full synchronization of the HP Network Automation by Java job with the integration point
that you just created. This job performs the following internal actions:
a. Establishes a connection to the target HP NA server.
b. Performs a query to retrieve IDs of all devices in the system.
c. Retrieves all devices in chunks. The default chunk size is 500 devices.
d. Retrieves all ports on all devices. Depending on the value of parameter
queryTopologyPerDevice, the ports are retrieved per device or from all devices at once.
e. Retrieves all device modules. Depending on the value of parameter queryTopologyPerDevice,
the device modules are retrieved per device or from all devices at once.
f. Retrieves all VLANs.
g. Retrieves connections between devices. Depending on the value of parameter
queryTopologyPerDevice, the connections are retrieved per device or from all devices at once.
h. Retrieves configuration of each device as textual data (if reportDeviceConfigs=true).
i. Analyzes topology. Port channels are identified with related child ports, port aliases are
identified along with the parent port.
j. Reports the topology. The job forms result vectors with information about devices and their
connections, while trying to not exceed 10000 objects in one vector. Vectors are sent to the
UCMDB server.
Pull Topology from HP NA Adapter
This section contains information on the Pull Topology from HP NA Adapter.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 260 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 9: HP Network Automation (NA) Integration
Input CIT
IpAddress
Triggered CI Data
Name
Value
ip_address
${SOURCE.name}
Used Scripts
l
network_automation.py
l
na_discover.py
l
na_integration_by_java.py
Discovered CITs
l
Composition
l
ConfigurationDocument
l
Containment
l
HardwareBoard
l
Interface
l
IpAddress
l
Layer2Connection
l
Membership
l
Node
l
PhysicalPort
l
Realization
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 261 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 9: HP Network Automation (NA) Integration
l
Vlan
Limitations
Delta synchronization is not supported by the Pull Topology from HP NA adapter. It is not possible to run
the HP Network Automation by Java job and synchronize only changes since the last run.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 262 of 366
Chapter 10: HP Network Node Manager (NNMi)
Integration
This chapter includes:
Overview
Use Cases
264
264
Supported Versions
264
NNMi - UCMDB Integration Architecture
265
Topology
266
How to Run NNMi–UCMDB Integration
266
How to Manually Add the IpAddress CI of the NNMi Server
269
How to Set Up HP NNMi–HP UCMDB Integration
270
NNMi Integration Job
271
How to Customize Integration
276
Troubleshooting and Limitations
280
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 263 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 10: HP Network Node Manager (NNMi) Integration
Overview
You integrate NNMi with UCMDB using the Data Flow Management (DFM) application.
When you activate the NNMi integration, DFM retrieves Layer 2 network topology data from NNMi and
saves the data to the UCMDB database. Users can then perform change management and impact
analysis.
Use Cases
The documentation for this integration is based on the following use cases:
l
Use Case 1: A UCMDB user wants to view the Layer 2 network topology supporting servers and
applications. The requirement is to use NNMi as the authoritative source for that information with
access through the UCMDB application.
l
Use Case 2: An NNMi operator wants to view the impact of a network access switch infrastructure
failure where the impact data is available in UCMDB. The NNMi operator selects an incident or a node
in NNMi and then enters a request for impacted CIs.
Supported Versions
Out of the box, the following software versions are supported:
l
Data Flow Probe version 9.02 or later
l
HP NNMi version 8.1, 8.11, 9.x, and 10.00
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 264 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 10: HP Network Node Manager (NNMi) Integration
NNMi - UCMDB Integration Architecture
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 265 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 10: HP Network Node Manager (NNMi) Integration
Topology
Layer2 by NNM Job
Note: For a list of discovered CITs, see "Discovered CITs" on page 274.
How to Run NNMi–UCMDB Integration
This task includes the steps to run the NNMi-UCMDB integration jobs.
Note: To avoid conflict, do not run the UCMDB Layer 2 discovery jobs when running the NNMi
integration.
This task includes the following steps:
1.
Run NNMi Integration
In the Integration Studio, create a new integration point.
a. Provide a name and description for the integration point.
b. Under Integration Properties > Adapter, select the appropriate adapter:
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 266 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 10: HP Network Node Manager (NNMi) Integration
l
Pull Topology from NNMi: Use this adapter to run population jobs.
This job connects to the NNMi Web service and retrieves NNMi discovenodes, IPs, networks,
interfaces, physical ports, VLANs, hardware boarLayer 2 connection information to create a
Layer 2 topology in UCMDB.
l
NNMI Update IDs: Use this adapter to run push jobs. This job:
l
Retrieves the UCMDB IDs of the NNMi hosts from the UCMDB Server using the UCMDB
Web Services API.
l
Updates the UCMDB_ID custom attribute on the corresponding node object on the NNMi
server using the NNMi Web service.
c. Under Adapter Properties > Data Flow Probe, select the Data Flow Probe.
d. Under Adapter Properties > Trigger CI instance select:
l
Select Existing CI (if you have a valid, existing CI). The Select Existing CI pane appears.
Select the CI; or
l
Create New CI (if you need to create a new CI). The Topology CI Creation Wizard appears.
Complete the creation of the CI using the Wizard.
Note: For details on the Topology CI Creation Wizard, see "Topology CI Creation Wizard" in
the HP Universal CMDB Data Flow Management Guide.
e. Under Adapter Properties > Credentials ID select the appropriate credentials for connection
to the NNMi server.
f. Save the Integration Point.
g. Run the job.
Note: For details on running an integration job, see "Integration Studio" in the HP Universal
CMDB Data Flow Management Guide.
2.
Validate results
Verify that data was discovered using the NNMi integration jobs.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 267 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 10: HP Network Node Manager (NNMi) Integration
a. For the NNMi population job:
l
In UCMDB, navigate to Managers > Modeling > IT Universe Manager.
l
In the CI Selector pane, select View Browser.
l
In the View drop-down menu, select Layer 2. Select a view. The view displays the CIs and
relationships discovered by the integration job.
b. For the NNMi push job:
l
In NNMi, open an NNMi node that was discovered in UCMDB.
l
On the Custom Attributes tab, look for the UCMDB_ID custom attribute. This attribute
should contain the UCMDB ID of the corresponding host in UCMDB.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 268 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 10: HP Network Node Manager (NNMi) Integration
How to Manually Add the IpAddress CI of the NNMi
Server
Note: When you installed HP Universal CMDB, you may have installed a bundled UCMDB that uses a
Foundation license. If your UCMDB installation has a Foundation license deployed, use the steps in
this section to manually add an IpAddress CI. If any other license (Basic or Advanced) is deployed on
the UCMDB server, discover the IPAddress CI as described in "How to Run NNMi–UCMDB Integration"
on page 266.
To manually add the IpAddress CI of the NNMi server
1. Verify that the Data Flow Probe is correctly installed and connected to the UCMDB Server.
2. Add the IP of the NNMi server to the Data Flow Probe range:
In the Data Flow Probe Setup module, select the Probe that is to be used for the NNMi integration,
and add the IP address of the NNMi server to its range. For details, see the section describing how
to add Probe range in the HP Universal CMDB Data Flow Management Guide.
3. Insert the Address CI of the NNMi server in the CMDB:
a. In Modeling > IT Universe Manager, in the CI Selector pane, click the Browse Views tab and
select Network Topology from the View drop-down menu.
b. Click the New CI
button.
c. In the New CI dialog box, select the IpAddress CIT from the tree and enter the following values:
Field
Description
IP Address
The IP address of the NNMi server.
IP Domain Name
The UCMDB domain name (for example, DefaultDomain).
IP Probe Name
The name of the Data Probe (for example, DefaultProbe).
d. Save the IpAddress CI.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 269 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 10: HP Network Node Manager (NNMi) Integration
How to Set Up HP NNMi–HP UCMDB Integration
The following steps describe how to configure NNMi to communicate with UCMDB:
Configure the connection between NNMi and UCMDB
On the NNMi management server, do the following:
1. In the NNMi console, open the HP NNMi–HP UCMDB Integration Configuration form (Integration
Module Configuration > HP UCMDB).
2. Select the Enable Integration check box to activate the remaining fields on the form.
3. Enter the information for connecting to the NNMi management server.
4. Enter the information for connecting to the UCMDB server.
5. Click Submit at the bottom of the form.
A new window displays a status message. If the message indicates a problem with connecting to
the UCMDB server, re-open the HP NNMi–HP UCMDB Integration Configuration form (or press
ALT+LEFT ARROW in the message window), and then adjust the values for connecting to the
UCMDB server as suggested by the text of the error message.
Customize the integration
On the NNMi management server, do the following:
1. In the NNMi console, open the HP NNMi–HP UCMDB Integration Configuration form (Integration
Module Configuration > HP UCMDB).
2. Enter values for the following fields:
o
HP UCMDB Correlation Rule Prefix
o
HP UCMDB Impact Severity Level (1–9)
3. Click Submit at the bottom of the form.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 270 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 10: HP Network Node Manager (NNMi) Integration
NNMi Integration Job
Adapter Parameters
Parameter
Description
discoverDisabledIps
Defines whether the integration should discover disabled IPs.
When set to false, the integration does not discover disabled IPs.
Default: false.
discoverLayer2
Defines whether the integration should discover the
Layer2Connection CIs from NNMi.
When set to true, the integration fetches all the
Layer2Connections-related data, iteratively querying for a
specified number of Layer2Connections from NNMi (based on value
of the pageSizeLayer2 parameter), then querying for Network
Interfaces on the ends of Layer2Connection and Nodes hosting
these interfaces with instant push of collected topology to UCMDB.
Default: true
discoverNodes
Defines whether the integration should discover all the Nodes that
are registered in NNMi, regardless of their inclusion into Layer2
Topology or VLANs.
When set to true, integration fetches all the Nodes with connected
IpAddresses, Interfaces, HardwareBoards, Physical Ports and
IpSubnets, iteratively querying for a specified number of Nodes
with related data from NNMi (based on value of the
pageSizeNodes parameter) and instantly pushing collected
topology into UCMDB.
Default: true
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 271 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 10: HP Network Node Manager (NNMi) Integration
Parameter
Description
discoverNonManagedInterfaces Defines whether the integration should discover non-managed
interfaces.
When set to false, the integration does not discover non-managed
interfaces.
Default: false.
discoverNonManagedNodes
Defines whether the integration should discover non-managed
nodes.
When set to false, the integration does not discover non-managed
nodes.
Default: false.
When this parameter is set to true, discoverDisabledIps and
discoverNonManagedInterfaces are ignored for non-managed
nodes; the integration will discover everything, including disabled
ips and non-managed interfaces.
discoverPhysicalPorts
Defines whether the integration should discover physical ports.
When set to false, the integration does not discover physical ports.
Default: false.
When this parameter is set to false, the integration does not
discover VLANs and HardwareBoards.
discoverVlans
Defines whether the integration should discover all the VLANs that
are registered in NNMi.
When set to true, integration fetches all the VLANs with member
Physical Ports, Hardware Boards and Nodes hosting those Physical
Ports and Node-related topology, iteratively querying for a
specified number of VLANs (based on the value of pageSizeVlans
parameter), getting all the necessary related topology and
instantly reporting it back to UCMDB.
Default: true
This parameter is ignored if discoverPhysicalPorts is set to false.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 272 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 10: HP Network Node Manager (NNMi) Integration
Parameter
Description
discoveryMode
Specifies the adapter's mode of execution, either related or full.
Default: related
l
In related read mode, only a small subset of the topology is
read, starting from the root entity. For example, the following
is possible:
o
read several Nodes
o
read all entities related to these Nodes, including
Interfaces, Ip Addresses, Ports, and so on.
l
o
send date to UCMDB
o
continue with other Nodes
In full read mode, the entire topology is read into memory
before the data is processed and result vectors are formed.
This approach requires more memory, but reduces the number
of requests to the NNMi server. The job sends the topology in
chunks after more than 10,000 objects are accumulated for
sending. The Data Flow Probe then processes these chunks and
sends them to the UCMDB server.
Use the remoteJVMArgs parameter of the integration adapter
to increase the memory limits for the remote Java virtual
machine that executes the job, in case there is a lot of data in
NNMi. For example, setting the value of the remoteJVMArgs
parameter to Xmx4096m enables the remote JVM to consume
up to 4 GB of memory. As a general rule, reading 2 million
objects from NNMi consumes approximately 10-12 GB of
memory.
For full read mode, it is recommended to set all page sizes to
1000 (using the pageSizeLayer2, pageSizeNodes, and
pageSizeVlans parameters.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 273 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 10: HP Network Node Manager (NNMi) Integration
Parameter
Description
pageSizeLayer2
Defines the number of Layer2Connection CIs to fetch from NNMi
per one query.
Default: 5
pageSizeNodes
Defines the number of Nodes to fetch from NNMi per one query.
Default: 10
pageSizeVlans
Defines the number of VLANs to be queries from NNMi per one
query.
Default: 1
requestCustomAttributes
Enables global querying for custom attributes of entities in the
script. The script must still be modified to read the values and
report them (this code modification is expected to be made by the
customer). Without modification to the script, setting this
parameter to true has no effect. For performance reason, by
default, custom attributes are not read from the NNMi server .
Default: false
Discovered CITs
l
Composition
l
Containment
l
HardwareBoard
l
Interface
l
IPAddress
l
IpSubnet
l
Layer2Connection
l
Membership
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 274 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 10: HP Network Node Manager (NNMi) Integration
l
Node
l
PhysicalPort
l
Realization
l
Vlan
Note: To view the topology, see "Topology" on page 266.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 275 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 10: HP Network Node Manager (NNMi) Integration
How to Customize Integration
This section describes how to customize the NNM Integration package in order to report additional
attributes or entities, or to perform other changes.
Included Scripts
The NNM Integration package includes the scripts detailed in the following table:
Name
Description
nnmi_api.py
Implements API for accessing and retrieving data in NNM.
Includes definition of base entities, such as Node or Interface,
collections, topology and fetcher classes.
nnmi_filters.py
Support module used by nnmi_api.py. Includes definition of
filters, allowing creation of advanced expressions when querying
data in NNM. In general, you should not modify this script.
nnmi.py
Uses API provided by nnm_api.py to retrieve data, form topology
into ObjectStateHolder objects and send result to UCMDB.
NNM_Integration.py
Main entry point of the integration. Contains DiscoveryMain
method which is called by probe, and uses nnmi.py.
NNM_Integration_Utils.py
Previous version of NNM integration implementation, used by
CheckCred.py script which validates credentials.
NNM_Integration_Utils_9.py
Previous version of NNM integration implementation for UCMDB
9.0
NNM_Update_Ids.py
Support module which updates custom attribute in NNM with
UCMDB ID of the CI.
Customization Step by Step
The following steps illustrate customization of integration with an example, showing how you discover
and report an additional attribute for an Interface. In this example, the attribute is the
managementMode property in the NNM interface.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 276 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 10: HP Network Node Manager (NNMi) Integration
1. Prerequisites
a. You need to know the name of the attribute in NNM. Here it is managementMode.
b. You need to know the name of a method which should be called on the stub to read the
corresponding property of entity, in this case Interface. This information is in the
corresponding WSDL file or API documentation.
2. Property Retrieval
For the new property to be reported, it should be retrieved first. To do that, you must modify the
nnmi_api.py script.
a. Locate Entity class
Open nnm_api.py and find the corresponding Entity class. Entity class names follow the
pattern Nms*Entity. For this example, you want NmsInterfaceEntity.
b. Add new entry to field_names tuple
Add a new field to the field_names tuple. This tuple is used for real-time entity introspection,
mainly debugging.
Note: For use in Python classes, translate a camel cased field name into an underscore
separated field name. For example: management_mode.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 277 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 10: HP Network Node Manager (NNMi) Integration
c. Modify constructor of the Entity to read the new property
Modify __init__ method of the entity to read the new property. Modification depends on
whether you need property post-processing.
i. Simple read
Call the method on the stub.
ii. Read with post processing
Delegate reading of the property to a new method which performs post processing for
the retrieved value. In this case the new method is added to an NmsInterfaceEntity class
called _get_management_mode which just strips the value of white spaces and makes it
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 278 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 10: HP Network Node Manager (NNMi) Integration
lowercase.
3. Property reporting
Once the modifications to nnmi_api.py are done, the new property is available, but it is not
reported yet. To add reporting for this property, you need to modify the nnmi.py script.
a. Locate Builder class
Open the nnmi.py script and find the corresponding Builder class for the entity being
reported. All Builder names match the *Builder pattern. In your case, you need the
InterfaceBuilder class.
b. Locate a place where ObjectStateHolder is created
Each Builder has a build method and several other methods which assist in the creation of the
ObjectStateHolder. Find where this ObjectStateHolder is created either directly or indirectly by
calling the method in the modeling.py module. In your example, ObjectStateHolderis created
in the method _createInterfaceOsh.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 279 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 10: HP Network Node Manager (NNMi) Integration
c. Add new attribute reporting
Now you add reporting of the new property. Here, you report the new value to the attribute
interface_management_mode of the Interface CIT which you previously created.
Troubleshooting and Limitations
This section describes troubleshooting and limitations for NNMi Integration.
l
Problem: The NNMi Web service responds with a cannot interrogate model message.
Solution: This message usually indicates that the Web services request made to the NNMi server is
incorrect or too complex to process. Check the NNMi jbossServer.log file for details.
l
Problem: If an excessive number of nodes are to be updated with the same UCMDB ID, it may take a
while for the update adapter to complete.
Solution: The volume of data retrieved from the NNMi server might be large. The recommended
memory requirements for the Data Probe process is 1024 MB. Since the NNMi Web service enables
updating the individual nodes one at a time, the time to update the nodes may take a while.
l
Problem: The Layer 2 by NNM job finishes with the following warning: Failed to get any
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 280 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 10: HP Network Node Manager (NNMi) Integration
Layer 2 links from NNM.
Solution: Refer to technical article KM629927 on the HP support Web site at
http://support.openview.hp.com.
l
Problem: Either of the NNMi integration jobs fails with the following error in the DFM log files:
com.hp.ov.nms.sdk.node.NmsNodeFault: Cannot interrogate model.
Solution: This error typically means that the NNMi server failed to process the Web services call.
Check the following two logs on the NNMi server for exceptions when the integration was activated:
l
o
jbossServer.log
o
sdk.0.0.log
Problem: Either of the NNMi integration jobs fail with the following error: Could not find
Discovery Probe 'DefaultProbe'. Task for TriggerCI will not be created.
Solution:
a. Right-click the job and select Go To Adapter.
b. Click the Adapter Management tab.
c. Select the Override default Probe selection check box, and enter the name of the Probe used
for the NNMi integration in the Probe field.
d. Click Save to save the adapter, then reactivate the job against the IpAddress CI of the NNMi
server.
l
Problem: NNMi integration fails when using integration probe.
Solution: In case of using integration service, for the NNM ID Update integration, the JDBC driver
should be specified in the classpath as well.
If your UCMDB server uses Oracle, you need to add ../lib/mcoracle.jar to the remoteJVMClasspath
field as Adapter Properties when configuring the integration point; If your UCMDB server uses MS
SQL, add ../lib/mcsqlserver.jar to the remoteJVMClasspath field.
Limitation
When integrating with multiple NNMi servers, each node (host) may only be managed by one NNMi
server at the same time.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 281 of 366
Chapter 11: HP OneView Pull Integration
This chapter includes:
Overview
282
Discovery Mechanism
282
Supported Versions
282
Create an Integration Point between HP OneView and UCMDB
283
Data Mappings
286
Input CITs
286
Used Scripts
286
Discovered CITs
287
Global Configuration File
287
Topology Map
287
Troubleshooting and Limitations
288
Overview
HP OneView software provides management tools for converged infrastructure and are used by system
administrators to provision, control, and manage software-defined data center components.
This integration adapter pulls data from HP OneView, and then the data is sent to UCMDB.
Discovery Mechanism
A REST client on the Data Flow Probe connects to the HP OneView REST API to fetch data.
Supported Versions
This integration adapter supports HP OneView version 1.05 and the REST API version 4.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 282 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 11: HP OneView Pull Integration
Create an Integration Point between HP OneView and
UCMDB
1. Log on to UCMDB as an administrator.
2. Navigate to Data Flow Management > Integration Studio. A list of existing integration points is
displayed.
3. Click New Integration Point
. The New Integration Point dialog box opens.
4. Complete the Integration Properties and Adapter Properties fields as shown in the following table:
Field
(*Required)
Description
Integration Properties section
*Integration Name
Type the name (unique key) of the integration point.
Integration Description
Type a description of the current integration point.
*Adapter
From the Select Adapter dialog, click
and select HP Software
Products > HP OneView Integration
*Is Integration
Select this option to indicate the integration point is active.
Activated?
Adapter Properties section
*Credentials ID
Click the Select Credential Id
button. The Generic Protocol is
already selected in the Protocol pane and in the Credentials list.
o
Other credentials are not supported.
o
Ensure that the account has Read access to HP OneView.
To configure the credential for this integration point,
a. Ensure the Generic Protocol is selected, and then click
HP Universal CMDB (Content Pack 17.00 (CP17))
. The
Page 283 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 11: HP OneView Pull Integration
Field
(*Required)
Description
Generic Protocols Parameters dialog box opens.
b. Provide values for the following fields and click OK:
l
Network Scope: Use the default value ALL.
l
User Label: Type a label for the credential.
l
User Name: Provide the user name for the HP OneView
account.
l
Password: Click
and provide the password for the HP
OneView account.
c. Click OK twice.
*OneView URL
The URL of HP OneView.
Trust All SSL
Specifies whether to trust all SSL certificates when the HP OneView
Certificates
server does not have a valid certificate.
Type one of the following values:
True. Trust all SSL certificates.
False. Do not trust all SSL certificates.
Default value: True
*Data Flow Probe
The name of the Data Flow Probe/Integration service used to execute
the synchronization from.
Select IntegrationService for this integration.
Note: If the IntegrationService option does not exist, consult
with your UCMDB administrator for the best selection for your
requirements.
Trigger CI Instance
Click
and select one of the following options from the drop down
menu:
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 284 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 11: HP OneView Pull Integration
Field
(*Required)
Description
Select Existing CI. Select this option only if you want to select a valid,
existing CI. The Select Existing CI pane appears.
Create New CI. Select this option if you want to create a new CI. The
Topology CI Creation Wizard appears. Complete the creation of the CI
using the Wizard.
Note: For details on the Topology CI Creation Wizard, see
"Topology CI Creation Wizard" in the HP Universal CMDB Data Flow
Management Guide.
5. Click OK.
The integration point is created and its details are displayed.
o
Your settings are not saved to the server until you click on the OK button.
o
You can edit this integration point by selecting the Integration Point name in the
Integration Point pane and then clicking
6. (Optional) To start the job immediately, click
.
to perform a full synchronization.
o
The first Full Synchronization may take a while to complete.
o
If you do not want the job to begin immediately, the job will be scheduled to run.
To see results of the job, perform the following:
1. In Integration Studio, in the Integration Job pane, right click the HP OneView job.
2. In the drop down menu, click Show Results of Job.
o
The results of the previous job run that are stored in the Probe's database are displayed.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 285 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 11: HP OneView Pull Integration
o
If the job has not yet run, the following message is displayed: "no results found on selected
job".
o
Results are only displayed when jobs are run successfully.
Data Mappings
The following entities are mapped from HP OneView to UCMDB:
HP OneView
HP UCMDB
Datacenter
Datacenter
Rack
Rack
Enclosure
Enclosure
Server-hardware
Node
Interconnect
Fiber Channel Switch
PDU
Power Distribution Unit
Slot
Hardware Board
Port
Physical Port
Input CITs
Discovery Probe Gateway
Used Scripts
oneview_pull.py
oneview_connection_data_manager.py
oneview_client.py
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 286 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 11: HP OneView Pull Integration
oneview_rest.py
oneview_mapping_file_manager.py
oneview_mapping_implementation.py
oneview_mapping_interfaces.py
oneview_validators.py
oneview_decorators.py
Discovered CITs
DataCenter
Rack
Enclosure
Node
Fibre Channel Switch
Hardware Board
Physical Port
Power Distribution Unit
Global Configuration File
HPOneView/oneview.xml
Topology Map
Note: For a list of Discovered CITs, see "Discovered CITs" above
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 287 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 11: HP OneView Pull Integration
Troubleshooting and Limitations
l
Problem: You receive the following error message: "Failed to pull data from OneView"
Solution: View the communication log.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 288 of 366
Chapter 12: HP Service Anywhere Push
Integration
This section includes:
Overview
How Data is Synchronized Between UCMDB and Service Anywhere
290
290
Supported Versions
291
How to Integrate UCMDB and Service Anywhere
291
Set up UCMDB
291
Push CI Data from UCMDB to Service Anywhere
295
Schedule Data Push Jobs
298
Tailor the Integration
300
Integration Architecture
300
Change Adapter Settings
303
Customize an Existing Mapping
305
Add a New Mapping to the Integration
306
Troubleshooting and Limitations
HP Universal CMDB (Content Pack 17.00 (CP17))
309
Page 289 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 12: HP Service Anywhere Push Integration
Overview
Integration between HP Universal CMDB (UCMDB) and HP Service Anywhere ("SAW") enables you to share
information from UCMDB with Service Anywhere. Common use cases include Hardware, Installed
Software, Running Software, and Business Services.
You can use the integration to automate the creation and update of information in Service Anywhere.
This ensures Service Anywhere is kept up to date with real, accurate, discovered data in your
environment.
How Data is Synchronized Between UCMDB and Service
Anywhere
The following graphic shows the high-level components of the integration:
Note: The Push Adapter and Push Connector are executed in the Data Flow Probe/Integration
Service process.
UCMDB stores its information using CIs. The integration chooses which data to pull from UCMDB by
defining integration TQL queries. Each TQL query defines a superset of data relevant for the integration.
The UCMDB Push Engine:
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 290 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 12: HP Service Anywhere Push Integration
l
Retrieves the required data from UCMDB, using the given TQL query.
l
If set for differential synchronization, filters the data to include only the data that has changed
since the last execution of this synchronization.
l
Splits the data into multiple chunks without breaking consistency.
l
Sends the information to the Probe/Adapter
The Push Adapter is a generic framework for easily configuring push adapters, using only XML and
Groovy1. It allows easy mapping of the data from the UCMDB data model into the Service Anywhere
data model, and the transfer of this converted data into the Push Connector. For more information, see
Developing Push Adapters in the HP Universal CMDB Developer Reference Guide.
The Push Connector is a component that connects to the Push Adapter, built specifically to reconcile,
push, and handle the complex logic needed to synchronize data into Service Anywhere.
Supported Versions
This integration supports HP Service Anywhere version 1.00 and later.
How to Integrate UCMDB and Service Anywhere
To set up integration between UCMDB and Service Anywhere, you must complete the following steps:
1. "Set up UCMDB" below
2. "Push CI Data from UCMDB to Service Anywhere" on page 295
Set up UCMDB
To set up UCMDB, complete the following steps:
Create an Integration Point in UCMDB
1Groovy is an agile and dynamic language, natively supported by the Java Virtual Machine. It allows
simple scripting capabilities, while maintaining all the strengths and capabilities of Java. It can execute
simple String manipulation, and use 3rd party libraries. For more information, see http://groovy.codehaus.org/
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 291 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 12: HP Service Anywhere Push Integration
1. Log on to UCMDB as an administrator.
2. Go to Data Flow Management > Integration Studio. UCMDB displays a list of existing integration
points.
3. Click New Integration Point
. The New Integration Point dialog box is displayed.
4. Complete the Integration and Adapter Properties fields as shown in the following table:
Field
Required Description
Integration
Name
Yes
Type the name (unique key) of the integration point.
Integration
Description
No
Type a description of the current integration point.
Adapter
Yes
Select HP Software Products > Service Anywhere >Service
Anywhere Push Adapter
Is
Integration
Activated
Yes
Select this option to indicate the integration point is active.
Hostname/IP Yes
Type the external hostname or IP Address of the Service Anywhere
instance.
Port
Yes
The external communication port of the Service Anywhere instance.
Note: The Adapter automatically populates this field with the
default SSL port 443.
Web
application
Root
context
Yes
The Root context of Service Anywhere.
Note: The Adapter automatically populates this field.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 292 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 12: HP Service Anywhere Push Integration
Field
Required Description
Protocol
Yes
The protocol used to connect with Service Anywhere. The only valid
protocols are HTTPS and HTTP.
Note:
The Adapter automatically populates this field with the HTTPS
o
protocol.
For SSL connection to a specific Service Anywhere instance,
o
you must first import the certificate from the Service
Anywhere instance to the probe keystore. The keystore path
is:
\\<UCMDBHOST>\c:\hp\UCMDB\DataFlowProbe\
bin\jre\lib\security\cacerts
Credentials
ID
Yes
Click
and select Generic protocol. Do one of the following:
o
Select the appropriate credential
o
Create a new credential. Fore more information, see "How to
Create a New Credential" on page 295
Data Flow
Probe
Yes
Select the name of the Data Flow Probe/Integration service used to
execute the synchronization from.
Note: Do not use Auto-Select for this field.
Additional
Probes
No
Select additional probes to use when pushing to Service Anywhere in
order to increase redundancy.
5. Click Test Connection to make sure there is a valid connection.
6. Click OK.
The integration point is created and its detailed are displayed.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 293 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 12: HP Service Anywhere Push Integration
UCMDB creates a default data push job when creating the integration point. If needed you may
create or edit the existing job. For more information, see "Work with Data Push Jobs" in the HP
Universal CMDB Data Flow Management Guide.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 294 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 12: HP Service Anywhere Push Integration
How to Create a New Credential
If you need to create a new credential, you must complete the following steps:
1. Select Generic Protocol
2. Click Create new connection details for selected protocol type
.
3. Populate the fields on the Generic Protocol Parameters page, as follows:
Field
Value
Network Scope
Use the default value.
User Label
Type a label for the credential.
User Name
The name of the user used to connect to Service Anywhere.
Note: The user must have integration level permission in Service
Anywhere.
Password
The password of the user needed to connect to Service Anywhere.
Push CI Data from UCMDB to Service Anywhere
Data push jobs copy CI or CI relationship records from your UCMDB system to your Service Anywhere
system. To run a data push job, complete the following steps:
1. Log on to UCMDB as an administrator.
2. Go to Data Flow Management > Integration Studio. UCMDB displays a list of existing integration
points.
3. Select the integration point you created for Service Anywhere.
4. Select the default SAW Push job, or any other job you have created for this integration.
UCMDB Creates a default data push job when creating an integration point.The following table lists
the Topology Query Language (TQL) queries in the default data push job. If required, you may
create, update, or remove TQL queries for the push job. You may also need to update the mapping.
See "Customize an Existing Mapping" on page 305.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 295 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 12: HP Service Anywhere Push Integration
To access the out-of-the-box TQL queries for push, go to Modeling > Modeling Studio >
Resources, select Queries for Resource Type, and then go to Root > Integration > Service
Anywhere Push.
Note: The order in which the TQL queries are resolved is important.
TQL Query
Description
SAW_BusinessElement
Pushes Business Activity, Business Application, Business Function,
Business Process, Business Service, Business Infrastructure,
Business Transaction, CI Collection, Functional Groups, and
Organization CIs.
Note: Persons are not synchronized in this integration. You
must import Persons into Service Anywhere using LDAP.
Mapping XMLs:
SAW_Computer
o
businessElementCisMappings.xml
o
businessElementrelationsMappings.xml
Pushes nodes (Computers, Network Devices, etc.) and Location
CIs.
Mapping XMLs:
SAW_ComputerElement
o
computerCisMappings.xml
o
computerRelationsMappings.xml
Pushes Buffer, File System, File System Export, Installed Software,
and Logical Volume CIs.
Mapping XMLs:
o
computerCisMappings.xml
o
computerRelationsMappings.xml
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 296 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 12: HP Service Anywhere Push Integration
TQL Query
Description
SAW_
Pushes CPU, Disk Device, Environmental Sensor, Fan, Hardware
ComputerPhysicalElements Board, Memory Unit, Physical Ports, and Power Supply CIs.
Mapping XMLs:
SAW_ComputerRelations
o
computerPhysicalEelementCisMappings.xml
o
computerPhysicalElementRelationsMappings.xml
Pushes only relationships.
Note: The relationships that are pushed depend on the CIs
pushed in the preceding TQL queries.
Mapping XMLs:
o
SAW_NetworkEntity
computerRelationsMappings.xml
Pushes Interface, IpAddress, IpSubnet, Layer2 Connection, and
VLAN CIs.
Mapping XMLs:
SAW_RunningSoftware
o
computerCisMappings.xml
o
computerRelationsMappings.xml
Pushes Application Server, Cluster Resource Group, Cluster
Software, Failover Cluster, IpService Endpoint, Running
Software,and URI Endpoint CIs.
Mapping XMLs:
o
runningSoftwareCisMappings.xml
o
runningSoftwareRelationsMappings.xml
5. Run the job manually to see if the integration job works properly:
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 297 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 12: HP Service Anywhere Push Integration
a. To push all the relevant data for the job, click Full Synchronization
.
b. To push only the changes in the data since the job last executed, click Delta Synchronization
.
6. Wait for the job to complete; click Refresh
multiple times as needed until the job is completed.
7. When the job is completed, the job status becomes one of the following depending on the results:
o
Succeeded
o
Completed
o
Failed
8. Click the Statistics tab to view the results; if any errors occur, click the Query Status tab and Job
Errors tab for more information.
Note: For details about these tabs and managing the integration, see Integration Jobs Pane in
the HP Universal CMDB Data Flow Management Guide.
If the job completes successfully, you can view the UCMDB CI data in Service Anywhere.
Schedule Data Push Jobs
To schedule job executions directly from a data push job:
1. Log on to UCMDB as an administrator.
2. Go to Data Flow Management > Integration Studio. UCMDB displays a list of existing integration
points.
3. Select the integration point you created for the UCMDB - Service Anywhere.
4. Select the push job.
5. Click Edit Integration Job
.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 298 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 12: HP Service Anywhere Push Integration
Note: UCMDB allows you to define two different schedules for two types of data push:
Changes Synchronization and All Data Synchronization. It is recommended to use the
Changes Synchronization schedule to only synchronize changes and avoid synchronizing the
entire set of data each time.
6. Define a schedule for Changes Sync.
a. Click on the Changes Synchronization tab.
b. Select the Scheduler enabled option.
c. Select the scheduling options you want to use.
7. Click the All Data Synchronization tab and select the scheduling options you want to use.
8. Click OK.
9. Save the integration point.
Note: The out-of-the-box default job schedule is for a Changes Synchronization data push every 2
hours.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 299 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 12: HP Service Anywhere Push Integration
Tailor the Integration
This section includes:
Integration Architecture
300
Change Adapter Settings
303
Customize an Existing Mapping
305
Add a New Mapping to the Integration
306
Integration Architecture
This section includes:
l
"Data Flow Architecture" below
l
"Integration TQL Queries" on the next page
l
"Service Anywhere Rules and Flows" on the next page
l
"Data Mapping" on the next page
l
"Push Mapping" on the next page
Data Flow Architecture
1. The Push Engine executes the TQL query.
2. For a differential flow, the data is compared to the last synchronized data, and only the changes
are forwarded.
3. Data is then pushed to the Push Adapter.
4. The Push Adapter loads the correct mapping for the specific TQL query.
5. Data is mapped from the UCMDB data Model into the Service Anywhere Data model according to
the mapping XML.
6. Data is sent to the Push Connector.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 300 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 12: HP Service Anywhere Push Integration
7. The Push Connector orders all the data in a set of dependency trees, starting with the records that
do not depend on any other record.
8. The Push Connector starts reconciling and pushing any record without any dependencies, or a
record whose dependencies have already been reconciled/pushed to Service Anywhere.
a. The Push Connector first tries to reconcile with existing records
b. If it finds a match, it attempts to update that record,
c. If it does not find a match, it attempts to create a new record.
Integration TQL Queries
Any attribute using in the mapping flow of the Push Adapter should be marked in the selected layout of
the query node.
For more information, see Data Flow Management > Integration Studio > Integration Jobs Pane.
Service Anywhere Rules and Flows
For details of Service Anywhere rules and flows, refer to the Service Anywhere documentation.
Data Mapping
For details, see Developing Push Adapters in the HP Universal CMDB Developer Reference Guide.
Push Mapping
The following table describes variables in the Generic Push Adapter XML mapping file that are
specifically required for integration with Service Anywhere.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 301 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 12: HP Service Anywhere Push Integration
Variable
Description
externalId
The external ID of the CI in UCMDB.
serviceName
The Web service name used in the SOAP request.
attributesHierarchy
The location of the CI attributes in the SOAP request.
keysHierarchy
The location of the CI keys in the SOAP request.
keyTag
The key in the SOAP request that passes the value of the ID.
keyVal
The ID value from UCMDB.
retrieveRequestName
The name of the SOAP request for a retrieval operation.
createRequestName
The name of the SOAP request for a creation operation.
deleteRequestName
The name of the SOAP request for a delete operation.
updateRequestName
The name of the SOAP request for an update operation.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 302 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 12: HP Service Anywhere Push Integration
Change Adapter Settings
To change adapter settings:
1. Go to Data Flow Management > Adapter Management > SAWPushAdapter > Adapters.
2. Right-click SAWPushAdapter and click Edit Adapter Source.
3. Scroll down to the <adapter-settings> tag.
4. Edit the settings as required and click the Save button.
The following table shows the Settings relevant to the SAW Push Adapter:
Setting
Default
Description
replication.chunk.size
4,000
Defines the requested number of
CIs and Relationships sent in each
chunk. It is possible to adjust this
setting to try and improve
performance of the server and the
Probe.
is.new.generic.push.adapter true
Enables use of the correct generic
Push Adapter XSD.
PushConnector.class.name
com.hp.ucmdb.adapters.
The name of the Java class used to
sawpush.SAWPushAdapter
load the Push Connector.
Note: Only change this setting
if you are not using the out-ofthe-box connector.
support.ci.type.mapping
true
Specifies the mapping of single CIs
to single CIs.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 303 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 12: HP Service Anywhere Push Integration
Setting
Default
Description
parallel.thread.pool.size
5
The amount of threads used in
Parallel Push Mode. The more
threads, the more CPU used.
Increasing the pool size may lower
performance.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 304 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 12: HP Service Anywhere Push Integration
Customize an Existing Mapping
This example shows you how to add a new attribute to the integration, including the TQL query, and
Push Adapter Mapping. It enables the integration to push the attribute to Service Anywhere.
After completing the following steps, you may run the job with the customized mapping:
1. Add the new attribute to an existing Service Anywhere TQL query layout.
In this step you add the attribute of a specific CI to the integration TQL query, so that you can use
the attribute and value in the mapping.
a. Go to Modeling > Modeling Studio >Resources and select the Queries Resource Type.
b. Go to Queries > Root > Integration > Service Anywhere Push.
c. Select the TQL query containing the CI to which you want to add a new attribute, and doubleclick. The query is displayed in the main pane.
For example, if you are adding a new attribute bt_example to the Business Transaction CI,
double-click the SAW_BusinessElement query.
d. Select the specific CI for which you want to add an attribute, right-click and select Query Node
Properties. The Query Node Properties dialog box is displayed.
e. Go to the Element Layout tab.
f. Move the new attribute to the Specific Attributes box.
g. Click OK.
h. Save the query.
2. Add the new attribute to the corresponding push adapter mapping.
In this step, you take the value from the TQL result, and remodel it to the Service Anywhere data
model.
a. Go to Data Flow Management > Adapter Management > Packages > SAWPushAdapter >
Configuration Files, and select the XML file corresponding to the CI to which you have added a
new attribute.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 305 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 12: HP Service Anywhere Push Integration
For example, if you are adding a new attribute bt_example to the Business Transaction
CI, select the businessElementCisMappings.xml file.
b. Go to the source_ci_type XML tag for the element that matches the name of the element in
the TQL you edited.
Continuing the previous example, you go to:
<source_ci_type query-element-name="BusinessTransaction*"
extends="AbstractBusinessNode">
c. Add the target mapping to hold the value of the new attribute.
Continuing the previous example:
<target_mapping name="bt_example" datatype="STRING"
value ="BusinessTransaction.attributeExists('bt_example') ?
BusinessTransaction['bt_example']: 'MISSING'"/>
d. Click OK.
Add a New Mapping to the Integration
This example shows how to add a new TQL query and push-mapping to the integration for a CIT called
Example. It consists of the following steps:
Step 1: Create a TQL Query
1. Go to Modeling > Modeling Studio > New > Query.
2. From the CI Types tab, add Example CIT to the query.
3. Right-click the Example Query Node and select Query Node Properties.
4. Go to the Element Layout tab.
5. Select Select attributes for layout.
6. In the Attributes condition drop down, select Specific Attributes, and add the new attributes that
you want to map and push to Service Anywhere.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 306 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 12: HP Service Anywhere Push Integration
7. Click OK.
8. Save the query to Modeling > Modeling Studio > Resources > Queries > Root > Integration >
Service Anywhere Push.
Step 2: Create a Push-Mapping
1. Go to Data Flow Management > Adapter Management > SAWPushAdapter.
2. Click Create new resource
and select New Configuration File.
3. Type the a name for the file.
4. Select the SAWPushAdapter package.
5. Click OK.
6. Copy the following into the newly created XML file, replacing ExampleCI with the name of the
relevant CI:
<integration
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="../generic-push-adapter.xsd">
<info>
<source name="UCMDB" versions="10.0" vendor="HP"/>
<target name="ServiceAnywhere" versions="1.0" vendor="HP"/>
</info>
<import>
<scriptFile path="mappings.scripts.SAWPushFunctions"/>
</import>
<targetcis>
<source_ci_type query-element-name="ExampleCI*">
<target_ci_type name="ExampleCI">
<variable name="externalId" datatype="STRING"
value="ExampleCI['external_id_obj']"/>
<variable name="serviceName" datatype="STRING"
value="'CMDB_UDM_1_6'"/>
<variable name="attributesHierarchy" datatype="STRING"
value="'model.instance'"/>
<variable name="keysHierarchy" datatype="STRING"
value="'model'"/>
<variable name="keyTag" datatype="STRING" value="'ID'"/>
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 307 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 12: HP Service Anywhere Push Integration
<variable name="keyVal" datatype="STRING"
value="ExampleCI['cmdb_id']"/>
<variable name="retrieveRequestName" datatype="STRING"
value="'RetrieveExampleCI'"/>
<variable name="createRequestName" datatype="STRING"
value="'CreateExampleCI'"/>
<variable name="deleteRequestName" datatype="STRING"
value="'DeleteExampleCI'"/>
<variable name="updateRequestName" datatype="STRING"
value="'UpdateExampleCI'"/>
<target_mapping name="Name" datatype="STRING"
value="ExampleCI.attributeExists('name') ?
((ExampleCI['name']==null)
?ExampleCI['display_label']:ExampleCI['name']) :
'MISSING'"/>
<target_mapping name="Description" datatype="STRING"
value="ExampleCI.attributeExists('description')
? ExampleCI['description'] : 'MISSING'"/>
<target_mapping name="DisplayLabel" datatype="STRING"
value="ExampleCI.attributeExists('display_label')
? ExampleCI['display_label'] : 'MISSING'"/>
<target_mapping name="GlobalId" datatype="STRING"
value="ExampleCI.attributeExists('global_id')
? ExampleCI['global_id'] : 'MISSING'"/>
</target_ci_type>
</source_ci_type>
</targetcis>
</integration>
7. Click OK.
Step 3: Create a Job with the New TQL Query
1. Go to Data Flow Management > Integration Studio.
2. Create an Integration Point with Service Anywhere.
3. In the Integration Jobs tab, click New Integration Job
.
4. Insert a job name in the Name field.
5. Click Add Query
, and choose the newly created query.
6. Click OK.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 308 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 12: HP Service Anywhere Push Integration
Step 4: Run the Job
1. Click on the job created in "Step 3: Create a Job with the New TQL Query".
2. Click Full Synchronization
.
3. Wait for the job to complete; click Refresh
multiple times as needed until the job is completed.
4. Make sure that the status is Succeeded.
Step 5: View the Results
1. Go to Service Anywhere.
2. Validate that the new attribute, pushed in the previous steps, is displayed.
Troubleshooting and Limitations
The Service Anywhere push adapter assumes that relationships comply with the Universal Data Model
specification. The adapter pushes CIs that comply with the specification, and ignores those that do not
comply.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 309 of 366
Chapter 13: HP Service Manager Integration
The UCMDB-SM integration supports different Service Manager adapters depending on the product
versions. For instructions on how to set up the integration by using a Service Manager adapter, see the
specific adapter guide.
Service Manager Adapter
Adapter User Guide
Supported
Service
Manager
Version
ServiceManagerAdapter9-41
See CP_HP_Integrations_SM941_xslt.pdf
9.41
ServiceManagerEnhancedAdapter9- See CP_HP_Integrations_SM941_Generic.pdf
9.41
41
ServiceManagerAdapter9-x
See CP_HP_Integrations_SM940_xslt.pdf
ServiceManagerEnhancedAdapter9- See CP_HP_Integrations_SM940_Generic.pdf
9.40
9.40
x
ServiceManagerAdapter9-x
See the Universal CMDB Integration Guide for your
9.3x
specific Service Manager version 9.3x. You can
download the guide from the HP Software
Support Online (SSO) website.
ServiceManagerAdapter9-2
See CP_HP_Integrations_SM9.2.pdf
9.2x
ServiceManagerAdapter7-1
See CP_HP_Integrations_SM7.1.pdf
7.1x
See CP_HP_Integrations_SM6.2.pdf
6.2x
ServiceManagerAdapter7-0
ServiceManagerAdapter6-2
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 310 of 366
Chapter 14: Storage Essentials (SE) Integration
This chapter includes:
Overview
313
Supported Versions
313
How to Perform the SE Integration
313
Storage Essentials Integration Packages
315
Adapter Parameters
316
Discovered CITs and Relationships
317
Node Details
319
SAN Topology
320
Storage Topology
320
Views
321
Storage Array Details
321
FC Switch Details
322
FC Switch Virtualization
322
Storage Pool Details
323
Host Storage Details
323
SAN External Storage
324
SAN Topology
325
Storage Topology
325
FC Port to FC Port
326
Impact Analysis Rules
326
FC Port to FC Port
326
FC Switch Devices to FC Switch
327
Host Devices to Host
327
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 311 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 14: Storage Essentials (SE) Integration
Logical Volume to Logical Volume
328
Storage Array Devices to Storage Array
328
Reports
328
Storage Array Configuration
329
Host Configuration
329
Storage Array Dependency
329
Host Storage Dependency
330
Storage Pool Configuration
330
Troubleshooting and Limitations
330
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 312 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 14: Storage Essentials (SE) Integration
Overview
Integration involves synchronizing devices, topology, and the hierarchy of a customer storage
infrastructure in the Universal CMDB database (CMDB). This enables Change Management and Impact
Analysis across all business services mapped in UCMDB from a storage point of view.
You integrate SE with UCMDB using Data Flow Management (DFM).
When you activate the Storage Essentials integration, DFM retrieves data from the SE Oracle database
and saves CIs to the Universal CMDB database. Users can then view SE storage infrastructure in UCMDB.
The data includes information on storage arrays, fibre channel switches, hosts (servers), storage
fabrics, logical volumes, host bus adapters, storage controllers, and fibre channel ports. Integration also
synchronizes physical relationships between the hardware, and logical relationships between logical
volumes, storage zones, storage fabrics, and hardware devices.
Supported Versions
The integration procedure supports SE versions 6.x, 9.4, 9.41, 9.5, 9.6, 9.6.1, and 9.70.
How to Perform the SE Integration
This task includes the steps to perform SE-UCMDB integration.
1. Prerequisites.
a. Configure database connection for the integration (PostgreSQL only)
i. Download the latest JDBC driver for PostgreSQL from
http://jdbc.postgresql.org/download.html (the package name is postgresql-9.31102.jdbc41.jar, for jdbc41) and place it on the UCMDB server in the following directory:
C:\hp\UCMDB\DataFlowProbe\runtime\probeManager\discoveryResources\db\postgre
sql
ii. Add the following line to the C:\HP\data\HPSEData\pg_hba.conf file on the SE
PostgreSQL database server:
host
all
HP Universal CMDB (Content Pack 17.00 (CP17))
report_user
all
trust
Page 313 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 14: Storage Essentials (SE) Integration
b. Add the Storage Essentials server IP address to the Data Flow Probe IP ranges.
In UCMDB, go to Data Flow Management > Data Flow Probe Setup. Choose the probe
corresponding to the UCMDB server and add the IP address or the IP range of the SE database
server (whether Oracle or PostgreSQL).
c. Define credentials for the SE database (Oracle and/or PostgreSQL) using the Generic DB
Protocol.
d. Run the following jobs for Oracle and/or PostgreSQL:
l
For Oracle database, run one of the following sets of jobs to trigger SE discovery:
l
Set 1:
l
Network Infrastructure > Basic > Range IPs by ICMP (discovers the IP address of the
SE server.)
l
Network Infrastructure > Host Connection > Host Connection by Shell/WMI/SNMP
(discovers operating system information on the SE server)
l
Hosts and Resources > Basic Applications > Host Applications by Shell/SNMP/WMI
(discovers the Oracle database instance used by SE)
l
Database > Oracle > Oracle Database Connection by SQL (discovers Oracle
databases using the Generic DB Protocol (SQL))
l
Set 2:
l
Network Infrastructure > Basic > Range IPs by ICMP (discovers the IP address of the
SE server)
l
Database > Oracle > Databases TCP Ports
l
Database > Oracle > Oracle Database Connection by SQL (discovers Oracle
databases using the Generic DB Protocol (SQL))
l
For PostgreSQL database
l
Network Discovery > Basic > Class C IPs by ICMP (if we have provided single IP for the
PostgreSQL server)
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 314 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 14: Storage Essentials (SE) Integration
l
Network Infrastructure > Basic > Range IPs by ICMP (if we have provided range of IPs
for the PostgreSQL server)
l
Database > PostgreSQL > Databases TCP Ports
l
Database > PostgreSQL > PostgreSQL Connection by SQL
2. Create a new integration point.
For details on running integration jobs, see "Integration Studio" in the HP Universal CMDB Data Flow
Management Guide.
a. Provide a name and description for the integration point.
b. Under Integration Properties > Adapter, select the Storage Essentials adapter.
c. Under Adapter Properties > Data Flow Probe, select the Data Flow Probe.
d. Under Adapter Properties >Trigger CI instance select:
i. Select Existing CI (if you have a valid, existing CI). The Select Existing CI pane appears.
Select the CI or
ii. Create New CI (if you need to create a new CI). The Topology CI Creation Wizard appears.
Complete the creation of the CI using the Wizard.
Note: For details on the Topology CI Creation Wizard, see "Topology CI Creation Wizard" in
the HP Universal CMDB Data Flow Management Guide.
e. Verify the credentials for the chosen CI instance. Right-click Trigger CI instance and select
Actions > Edit Credentials Information.
f. Save the integration point.
3. Run the HP Storage Essentials job.
Storage Essentials Integration Packages
The integration includes two UCMDB packages:
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 315 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 14: Storage Essentials (SE) Integration
l
SE_Integration.zip. Contains the trigger query for SE discovery, discovery script, adapter, and job.
l
Storage_Basic.zip. Contains the new CI Type definitions, views, reports, and impact analysis rules.
This package is common to all Storage Management integration solutions.
Tip: You can include the SE job in the DFM schedule.
For details, see "New Integration Job/Edit Integration Job Dialog Box" in the HP Universal CMDB Data
Flow Management Guide.
Adapter Parameters
This job runs queries against Oracle materialized views that are installed and maintained by Storage
Essentials in the Oracle database. The job uses a database CI as the trigger.
A switch or server in SE inherits from a Node CIT in UCMDB based on the following adapter parameters:
Parameter
Description
allowDNSLookp
If a node in the SE database does not have an IP address but has a DNS
name, it is possible to resolve the IP address by the DNS name.
True: If a node does not have an IP address, an attempt is made to
resolve the IP address by DNS name (if a DNS name is available).
Default: False
ignoreNodesWithoutIP
Defines whether or not nodes in SE without IP addresses should be
pulled into UCMDB.
l
True. Nodes without IPs are ignored.
l
False. A Node CI is created with an SE ID as the node key attribute.
Note: Setting this parameter to False may result in duplicate
CIs in the CMDB.
Default: True
ignorePortsWithoutWWN
If set to true, the integration ignores Fiber Channel Ports that do not
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 316 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 14: Storage Essentials (SE) Integration
Parameter
Description
have a WWN.
Default: True
Discovered CITs and Relationships
This section describes SE storage entities in UCMDB:
l
Fibre Channel Connect. Represents a fibre channel connection between fibre channel ports.
l
Fibre Channel HBA. Has change monitoring enabled on parameters such as state, status, version,
firmware version, driver version, WWN, and serial number. A Fibre Channel HBA inherits from the
Node Resource CIT.
l
Fibre Channel Port. Has change monitoring enabled on parameters such as state, status, WWN, and
trunked state. Since a Fibre Channel Port is a physical port on a switch, it inherits from the Physical
Port CIT under the NodeElement Resource CIT.
l
Fibre Channel Switch. Falls under the Node CIT because SE maintains an IP address for each switch.
Parameters such as status, state, total/free/available ports, and version are change monitored.
This package retrieves Fibre Channel Switch details from the mvc_switchsummaryvw and mvc_
switchconfigvw views. The job retrieves detailed information about Fibre Channel Ports on each
switch from the mvc_portsummaryvw view.
l
Logical Volume. Represents volumes on storage arrays and hosts with change monitoring on
availability, total/free/available space, and storage capabilities.
l
Tape: Represents a tape library.
l
Storage Array. Represents a storage array with change monitoring on details such as serial number,
version, and status. Since a storage array may not have a discoverable IP address, it inherits from
the Network Device CIT.
l
NetApp Filer. This is a specialized storage array from the NetApp application.
Both Storage Array and NetApp Filer CITs retrieve details from the mvc_storagesystemsummaryvw
view. DFM retrieves detailed information on Storage Processors and HBAs from the mvc_
storageprocessorsummaryvw and mvc_cardsummaryvw tables respectively.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 317 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 14: Storage Essentials (SE) Integration
The SE database may possibly not be able to obtain IP address information on storage arrays for a
variety of technical and policy related reasons.
Since Fibre Channel Ports may be present on a storage array, Storage Processor, or HBA, DFM uses three
separate queries to retrieve Fibre Channel Ports for each storage array. Detailed information about
Fibre Channel Ports on each array is retrieved from the mvc_portsummaryvw view. Since this view uses
a container ID as the key, DFM queries the view by container ID for each storage array, each Storage
Processor on a storage array, and each HBA on a storage array.
DFM retrieves detailed information about Logical Volumes on each storage Array from the mvc_
storagevolumesummaryvw view.
DFM retrieves detailed information about Tape Library from the mvc_tapelibrarysummaryvw view.
Results from these queries populate a map as shown below:
l
Storage Fabric. Inherits from the Network Resource CIT and represents a storage fabric. This CIT
has no change monitoring enabled.
l
Storage Processor. Represents other storage devices such as SCSI controllers, and inherits from the
Host Resource CIT. A Storage Processor CIT monitors change on parameters such as state, status,
version, WWN, roles, power management, and serial number.
l
Storage Pool. Storage Pool information is also collected from each storage array using the query
below.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 318 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 14: Storage Essentials (SE) Integration
Results from this query populate a map as shown below:
Node Details
DFM retrieves Host details from the mvc_hostsummaryvw view and detailed information on HBAs from
the mvc_cardsummaryvw view.
SE maintains information on Operating Systems, IP address, and DNS name on each host. DFM uses this
information to create Node CIs (UNIX or Windows) and IpAddress CIs.
Since UCMDB uses the IP address of a node as part of its primary key, DFM attempts to use the IP
address from SE for this purpose. If an IP address is not available, DFM then attempts to resolve the
hosts IP address using a DNS name. If neither an IP address nor a DNS name is available, DFM ignores
the host (see "Adapter Parameters" on page 316.
Similar to Storage Arrays, a node may have Fibre Channel Ports directly associated with itself or on HBAs
on the host. The DFM job uses three separate queries to retrieve Fibre Channel Ports for each host. The
job retrieves detailed information about Fibre Channel Ports on each host from the mvc_
portsummaryvw view. Since this view uses a ContainerID attribute as the key, the job queries the view
by containerID for each host, and each HBA on a host.
Finally, DFM retrieves detailed information about Logical Volumes on each host from the mvc_
hostvolumesummaryvw and mvc_hostcapacityvw views. The mvc_hostcapacityvw view maintains
capacity information for each volume over multiple instances in time, and the job uses only the latest
available information.
Results from these queries populate a map as shown below:
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 319 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 14: Storage Essentials (SE) Integration
SAN Topology
SAN Topology consists of the Fibre Channel network topology and includes (fibre channel) connections
between Fibre Channel Switches, Hosts, and Storage Arrays. SE maintains a list of WWNs that each Fibre
Channel Port connects to, and this package uses this list of WWNs to establish Fibre Channel Connection
links.
Results from these queries populate a map as shown below:
Storage Topology
Storage topology consists of relationships between Logical Volumes on a host and Logical Volumes on a
Storage Array. DFM uses multiple tables to identify this relationship as shown in the query below. This
view is a summary of all of the above information.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 320 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 14: Storage Essentials (SE) Integration
Results from these queries populate a map as shown below:
Views
The SE package contains views that display common storage topologies. These are basic views that can
be customized to suit the integrated SE applications.
Storage Array Details
This view shows a Storage Array and its components including Logical Volumes, HBAs, Storage
Processors, and Fibre Channel Ports. The view shows each component under its container Storage Array
and groups Logical Volumes by CI Type.
Storage Array does not require all components in this view to be functional. Composition links stemming
from the Storage Array have a cardinality of zero-to-many. The view may show Storage Arrays even
when there are no Logical Volumes or Storage Processors.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 321 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 14: Storage Essentials (SE) Integration
FC Switch Details
This view shows a Fibre Channel Switch and all connected Fibre Channel Ports.
FC Switch Virtualization
FC Switch Virtualization consists of a physical switch or chassis, partitioned into multiple logical
switches. Unlike Ethernet virtualization, physical ports are not shared among multiple virtual switches.
Rather, each virtual switch is assigned one or more dedicated physical ports that are managed
independently by the logical switches.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 322 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 14: Storage Essentials (SE) Integration
Storage Pool Details
This view shows Storage Pools with associated Storage Arrays and Logical Volumes.
Host Storage Details
This view shows only Hosts that contain a Fibre Channel HBA or a Logical Volume. This keeps the view
storage-specific and prevents hosts discovered by other DFM jobs from being included in the view.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 323 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 14: Storage Essentials (SE) Integration
SAN External Storage
External storage configuration consists of a storage array presenting a logical volume that, in reality,
belongs to another storage array. This is typically used in configurations where high-end, more
expensive, front-end arrays present volumes from back-end, cheaper, storage to servers. The goal of
this type of virtualization is to virtualize multiple disk arrays from different vendors, scattered over the
network, into a single monolithic storage device that can be managed uniformly.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 324 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 14: Storage Essentials (SE) Integration
SAN Topology
This view maps physical connections between Storage Arrays, Fibre Channel Switches, and Hosts. The
view shows Fibre Channel Ports below their containers. The view groups the Fibre Channel Connect
relationship CIT to prevent multiple relationships between the same nodes from appearing in the top
layer.
Storage Topology
This view maps logical dependencies between Logical Volumes on Hosts and Logical Volumes on Storage
Arrays. There is no folding in this view.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 325 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 14: Storage Essentials (SE) Integration
FC Port to FC Port
This rule propagates events on a Fibre Channel Port to another connected Channel Port.
Example of HBA crashing on a Storage Array:
l
The event propagates from the HBA to the Storage Array and the Logical Volumes on the Array
because of the Storage Devices to Storage Array rule.
l
The impact analysis event on the Logical Volume then propagates to other dependent Logical
Volumes through the Logical Volume to Logical Volume rule.
l
Hosts using those dependent Logical volumes see the event next because of the Host Devices to
Host rule.
l
Depending on business needs, you define impact analysis rules to propagate events from these
hosts to applications, business services, lines of business, and so on. This enables end-to-end
mapping and impact analysis using UCMDB.
Impact Analysis Rules
This package contains basic impact analysis rules to enable impact analysis and root cause analysis in
UCMDB. These impact analysis rules are templates for more complex rules that you can define based on
business needs.
All impact analysis rules fully propagate both Change and Operation events. For details on impact
analysis, see "Impact Analysis Manager Page" and "Impact Analysis Manager Overview" in the HP
Universal CMDB Modeling Guide.
Note: Impact analysis events are not propagated to Fibre Channel Ports for performance reasons.
FC Port to FC Port
This impact analysis rule propagates events between related fiber channel ports.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 326 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 14: Storage Essentials (SE) Integration
FC Switch Devices to FC Switch
This impact analysis rule propagates events from a Fibre Channel Port to and from a Switch. The event
is also propagated to the associated Storage Fabric.
Host Devices to Host
This impact analysis rule propagates events between Fibre Channel HBAs and Hosts, and Logical
Volumes on the Host.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 327 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 14: Storage Essentials (SE) Integration
Logical Volume to Logical Volume
This impact analysis rule propagates events on a Logical Volume contained in a Storage Array to the
dependent Logical Volume on the Host.
Storage Array Devices to Storage Array
This impact analysis rule propagates events between Logical Volumes, Storage Processors, Fibre
Channel HBAs, and Storage Arrays.
Reports
The SE package contains basic reports that can be customized to suit the integrated SE applications.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 328 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 14: Storage Essentials (SE) Integration
In addition to the system reports, Change Monitoring and Asset Data parameters are set on each CIT in
this package, to enable Change and Asset Reports in Universal CMDB. For details see " Storage Array
Configuration" below, " Host Configuration" below, " Storage Array Dependency" below, and " Host
Storage Dependency" on the next page.
Storage Array Configuration
This report shows detailed information on Storage Arrays and its sub-components including Fibre
Channel Ports, Fibre Channel Arrays, and Storage Processors. The report lists Storage Arrays with subcomponents as children of the Array.
Host Configuration
This report shows detailed information on hosts that contain one or more Fibre Channel HBAs, Fibre
Channel Ports, or Logical volumes. The report lists hosts with sub-components as children of the host.
Storage Array Dependency
This report maps dependencies on a Storage Array. The report also displays information on switches
connected to it.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 329 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 14: Storage Essentials (SE) Integration
Host Storage Dependency
This report shows detailed information on storage infrastructure dependencies of a Host. The report
lists hosts and dependent components.
Storage Pool Configuration
This report shows detailed information on Storage Pool configuration.
Troubleshooting and Limitations
This section describes troubleshooting and limitations of Storage Essentials Integration.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 330 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 14: Storage Essentials (SE) Integration
l
Problem: If the SE system has duplicate entries for nodes, switches or arrays, the job produces the
following error message: "Process validator error: multiple updates in bulk...".
Solution: This is expected behavior and does not affect population of valid CIs into UCMDB. To
prevent this error message, duplicates must be removed from the SE system.
l
Error message: "Please use the SE database with SID 'REPORT' for this integration."
Solution: For integration with SE 9.4 or higher, you should configure the integration point for a
REPORT database instance (and not for an APPIQ instance as applied for SE versions up to and
including 6.3).
l
Limitation: The credentials used for integration with SE should have access to the relevant
materialized view status table as detailed below:
Storage Essentials
Materialized View Status Table
Version 6.03 and earlier
appiq_system.mview_status
Later than Version 6.03 and earlier than Version appiq_system.mviewcore_status
6.1
and
appiq_system.mview_status
Later than Version 6.1 and earlier than Version
appiq_system.mview_module_status
9.4
Version 9.4 and later
l
appiq_system.mv_report_user_status
Limitation: If the discovery does not find a valid IP address and serial number for a VMWare ESX
server in the HP Storage Essentials database, that VMware ESX server is not reported to UCMDB.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 331 of 366
Chapter 15: HP Storage Operations Manager
(SOM) Integration
This chapter includes:
Overview
333
Supported Versions
333
How to Perform the SOM Integration
334
Install the Integration
334
Enable the Integration
334
Adapter Properties
337
Discovered CITs and Relationships
339
Node Details
340
SAN Topology
340
Storage Topology
341
Views
341
Storage Array Details
342
FC Switch Details
342
FC Switch Virtualization
343
Storage Pool Details
343
Host Storage Details
344
SAN External Storage
344
SAN Topology
345
Storage Topology
346
FC Port to FC Port
346
Impact Analysis Rules
347
FC Port to FC Port
347
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 332 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 15: HP Storage Operations Manager (SOM) Integration
FC Switch Devices to FC Switch
347
Host Devices to Host
348
Logical Volume to Logical Volume
348
Storage Array Devices to Storage Array
349
Reports
349
Storage Array Configuration
349
Host Configuration
350
Storage Array Dependency
350
Host Storage Dependency
351
Storage Pool Configuration
351
Known Issues
351
Overview
Integration involves synchronizing devices, topology, and the hierarchy of a customer storage
infrastructure in the HP Universal CMDB (UCMDB). This enables Change Management and Impact
Analysis across all business services mapped in UCMDB from a storage point of view.
Storage Operations Manager (SOM) communicates with UCMDB using Rest APIs via HTTPS protocols.
When you activate the SOM integration, HTTPS protocols retrieve data and saves CIs to UCMDB. Users
can then view SOM storage infrastructure in UCMDB.
The data includes information on storage arrays, fibre channel switches, hosts (servers), storage
fabrics, logical volumes, host bus adapters, storage controllers, and fibre channel ports. Integration also
synchronizes physical relationships between the hardware, and logical relationships between logical
volumes, storage pools, storage fabrics, and hardware devices.
Supported Versions
The integration procedure supports SOM version 10.01.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 333 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 15: HP Storage Operations Manager (SOM) Integration
How to Perform the SOM Integration
This section includes the steps to perform SOM-UCMDB integration.
Install the Integration
334
Enable the Integration
334
Install the Integration
The SOM-UCMDB integration is delivered as the HP_SOM_Integration.zip file. The package must be on
your local directory in order to deploy its resources.
1. Log in to UCMDB as an administrator.
2. Go to Administration > Package Manager.
3. Click the Deploy packages to server (from local disk) button.
4. In the Deploy Packages to Server dialog box, click the Add button.
5. Select the HP_SOM_Integration.zip package and click Open.
6. Select the resources from the package that you want to deploy. All the resources are selected by
default.
7. Click Deploy.
Enable the Integration
This task includes the steps to perform SOM-UCMDB integration.
This integration uses an external JAR and runs in a separate Java virtual machine (JVM) than other
UCMDB integrations.
Basic Setup
1. Go to Data Flow Management > Data Flow Probe Setup.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 334 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 15: HP Storage Operations Manager (SOM) Integration
In the UCMDB system services, the UCMDB_Probe service must be up and the UCMDB_Integration_
Service must be down.
2. In the Domains and Probes pane > Data Flow Probes tree, click the probe you want to use.
3. Under Ranges, click the
New icon to create a new range and enter SOM server details.
4. Click OK to create the range.
You can create more than one range on this page.
5. In the Domains and Probes pane >Credentials tree,
a. Choose WMI Protocol for SOM servers running Windows.
b. Choose SSH Protocol for SOM servers running Linux.
6. Click the
New icon in the protocol pane to set protocol parameters.
a. Click the Edit button to edit the network scope.
b. In the Scope Definition dialog box, click the Selected Range option button, and then click the
New icon to create a new range. Fill in the SOM server information and then click OK to add
the network scope.
c. Enter the SOM server log in credentials.
d. Click OK to save the protocol.
7. Select the HTTP Protocol, then the
New icon to set protocol parameters.
o
Follow the same setup procedure as WMI and SSH above.
o
The user name must be part of the web services client role.
To view what role the user belongs to, in the SOM console go to Configurations > Security > User
Account Mappings.
o
The timeout must be set to a minimum of 60,000 msec. (60 seconds)
o
Trust store information is optional.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 335 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 15: HP Storage Operations Manager (SOM) Integration
8. Go to Universal Discovery > Discovery Modules/Jobs tab > Discovery Modules tree > Network
Infrastructure > Basic.
a. Right-click one of the ICMP discovery jobs and select Activate.
b. Expand Host Connection in the file tree
l
For SOM servers running the Windows operating system, right-click Host Connection by
WMI and select Activate.
l
For SOM servers running Linux operating system, right-click Host Connection by Shell and
select Activate.
9. In Integration Jobs, right-click the job that was created and select run all-data sync to perform the
job.
Create the Integration
1. Add the SOM server IP address to the Data Flow Probe IP ranges.
Go to Data Flow Management > Data Flow Probe Setup. Choose the probe corresponding to the
UCMDB server.
2. Enter user name and password credentials to access SOM from UCMDB.
Certificate based authentication is optional.
3. Create a new Integration Point.
a. In the Integration Studio, click the
New icon to create a new integration.
b. Set Integration Properties.
i. Click the Select Adapter button next to the Adapter field to select an adapter.
“HP SOM Integration” for SOM 10.01
c. Set the adapter properties under the Integration Properties.
For more information, see "Adapter Properties" on the next page.
i. Set the credentials ID to the HTTPS protocol credential. This is the only option supported
for SOM 10.01.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 336 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 15: HP Storage Operations Manager (SOM) Integration
ii. Select the Data Flow Probe from the drop-down menu.
iii. Click the cube next to the trigger CI instance field and choose a CI.
The CI should be set to the IP of the SOM server.
4. Run the integration created in step 3.
Note: For information about running integration jobs, see "Integration Studio" in the HP Universal
CMDB Data Flow Management Guide.
Optional Configuration
For large SOM data sets, adjust the appilog.agent.local.max.worker.runtime value in the
<DataFlowProbe Installation folder>/conf/ DataFlowProbe.properties file to match your environment.
For example, with a SOM data set of approximately 15,000 elements, setting the argument to 3600000
resulted in acceptable behavior.
After modifying the DataFlowProbe.properties file, restart the DataFlowProbe service.
Adapter Properties
This job runs queries against Oracle materialized views that are installed and maintained by SOM in the
Oracle database. The job uses a database CI as the trigger.
A switch or server in SOM inherits from a Node CIT in UCMDB based on the following adapter properties:
Parameter
Description
Allow DNS Lookup
If a node in the SOM database does not have an IP address but
has a DNS name, it is possible to resolve the IP address by the
DNS name.
True: If a node does not have an IP address, an attempt is made
to resolve the IP address by DNS name (if a DNS name is
available).
Default: False
Credentials ID
The HTTP Protocol Credentials of the SOM management server
configured in UCMDB.
Ignore Nodes Without IP
Defines whether or not nodes in SOM without IP addresses
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 337 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 15: HP Storage Operations Manager (SOM) Integration
Parameter
Description
should be pulled into UCMDB.
l
True. Nodes without IPs are ignored.
l
False. A Node CI is created with a SOM ID as the node key
attribute.
Note: Setting this parameter to False may result in
duplicate CIs in the CMDB.
Default: True
Ignore Ports Without WWN
If set to true, the integration ignores Fiber Channel Ports that do
not have a WWN.
Default: True
Remote JVM Arguments
JVM parameters that are passed to the external JVM.
Default: -Xms1024m -Xmx2560m
Adjust the value of this argument to match your environment.
For example, with a SOM data set of approximately 15,000
elements, setting the argument to -Xms25G -Xmx25G -XX:UseGCOverheadLimit resulted in acceptable behavior.
Remote JVM Class Path
Set the external JVM class path.
Note: Do not change %minimal_classpath%.
Remote Process Timeout
Timeout for remote process in external JVM.
Set to a minimum of 60,000 m. sec. (60 seconds).
Adjust the value of this argument to match your environment.
For example, with a SOM data set of approximately 15,000
elements, setting the argument to 5400000 (m. sec.) resulted in
acceptable behavior.
Run In Separate Process
If set to true, the adapter will run in the external JVM.
Default: True
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 338 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 15: HP Storage Operations Manager (SOM) Integration
Parameter
Description
Note: Currently, this value must remain set to True.
Data Flow Probe
Name of the data flow probe for collecting SOM data.
Trigger CI Instance
IP address of the SOM management server.
Discovered CITs and Relationships
This section describes SOM storage entities in UCMDB:
l
Fibre Channel Connect. Represents a fibre channel connection between fibre channel ports.
l
Fibre Channel Port. Has change monitoring enabled on parameters such as state, status, WWN, and
trunked state. Since a Fibre Channel Port is a physical port on a switch, it inherits from the Physical
Port CIT under the NodeElement Resource CIT.
l
Fibre Channel Switch. Falls under the Node CIT because SOM maintains an IP address for each
switch. Parameters such as status, state, total/free/available ports, and version are change
monitore
l
Logical Volume. Represents volumes on storage arrays with change monitoring on availability,
total/free/available space, and storage capabilities.
l
Storage Array. Represents a storage array with change monitoring on details such as serial number,
version, and status. Since a storage array may not have a discoverable IP address, it inherits from
the Network Device CIT.
l
Storage Fabric. Inherits from the Network Resource CIT and represents a storage fabric. This CIT
has no change monitoring enabled.
l
Storage Processor. Represents other storage devices such as SCSI controllers, and inherits from the
Host Resource CIT. A Storage Processor CIT monitors change on parameters such as state, status,
version, WWN, roles, power management, and serial number.
l
Storage Pool. Storage Pool information is also collected from each storage array using the query
below.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 339 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 15: HP Storage Operations Manager (SOM) Integration
Results from this query populate a map as shown below:
Node Details
SOM maintains information on Operating Systems, IP address, and DNS name on each host. DFM uses
this information to create Node CIs (UNIX or Windows) and IpAddress CIs.
Since UCMDB uses the IP address of a node as part of its primary key, DFM attempts to use the IP
address from SOM for this purpose. If an IP address is not available, DFM then attempts to resolve the
hosts IP address using a DNS name. If neither an IP address nor a DNS name is available, DFM ignores
the host (see "Adapter Properties" on page 337.)
Results from these queries populate a map as shown below:
SAN Topology
SAN Topology consists of the Fibre Channel network topology and includes (fibre channel) connections
between Fibre Channel Switches, Hosts, and Storage Arrays. SOM maintains a list of WWNs that each
Fibre Channel Port connects to, and this package uses this list of WWNs to establish Fibre Channel
Connection links.
Results from these queries populate a map as shown below:
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 340 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 15: HP Storage Operations Manager (SOM) Integration
Storage Topology
Storage topology consists of relationships between Logical Volumes on a host and Logical Volumes on a
Storage Array. DFM uses multiple tables to identify this relationship as shown in the query below. This
view is a summary of all of the above information.
Results from these queries populate a map as shown below:
Views
The SOM package contains views that display common storage topologies. These are basic views that
can be customized to suit the integrated SOM applications.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 341 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 15: HP Storage Operations Manager (SOM) Integration
Storage Array Details
This view shows a Storage Array and its components including Logical Volumes, HBAs, Storage
Processors, and Fibre Channel Ports. The view shows each component under its container Storage Array
and groups Logical Volumes by CI Type.
Storage Array does not require all components in this view to be functional. Composition links stemming
from the Storage Array have a cardinality of zero-to-many. The view may show Storage Arrays even
when there are no Logical Volumes or Storage Processors.
FC Switch Details
This view shows a Fibre Channel Switch and all connected Fibre Channel Ports.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 342 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 15: HP Storage Operations Manager (SOM) Integration
FC Switch Virtualization
FC Switch Virtualization consists of a physical switch or chassis, partitioned into multiple logical
switches. Unlike Ethernet virtualization, physical ports are not shared among multiple virtual switches.
Rather, each virtual switch is assigned one or more dedicated physical ports that are managed
independently by the logical switches.
Storage Pool Details
This view shows Storage Pools with associated Storage Arrays and Logical Volumes.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 343 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 15: HP Storage Operations Manager (SOM) Integration
Host Storage Details
This view shows only Hosts that contain a Fibre Channel HBA or a Logical Volume. This keeps the view
storage-specific and prevents hosts discovered by other DFM jobs from being included in the view.
SAN External Storage
External storage configuration consists of a storage array presenting a logical volume that, in reality,
belongs to another storage array. This is typically used in configurations where high-end, more
expensive, front-end arrays present volumes from back-end, cheaper, storage to servers. The goal of
this type of virtualization is to virtualize multiple disk arrays from different vendors, scattered over the
network, into a single monolithic storage device that can be managed uniformly.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 344 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 15: HP Storage Operations Manager (SOM) Integration
SAN Topology
This view maps physical connections between Storage Arrays, Fibre Channel Switches, and Hosts. The
view shows Fibre Channel Ports below their containers. The view groups the Fibre Channel Connect
relationship CIT to prevent multiple relationships between the same nodes from appearing in the top
layer.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 345 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 15: HP Storage Operations Manager (SOM) Integration
Storage Topology
This view maps logical dependencies between Logical Volumes on Hosts and Logical Volumes on Storage
Arrays. There is no folding in this view.
FC Port to FC Port
This rule propagates events on a Fibre Channel Port to another connected Channel Port.
Example of HBA crashing on a Storage Array:
l
The event propagates from the HBA to the Storage Array and the Logical Volumes on the Array
because of the Storage Devices to Storage Array rule.
l
The impact analysis event on the Logical Volume then propagates to other dependent Logical
Volumes through the Logical Volume to Logical Volume rule.
l
Hosts using those dependent Logical volumes see the event next because of the Host Devices to
Host rule.
l
Depending on business needs, you define impact analysis rules to propagate events from these
hosts to applications, business services, lines of business, and so on. This enables end-to-end
mapping and impact analysis using UCMDB.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 346 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 15: HP Storage Operations Manager (SOM) Integration
Impact Analysis Rules
This package contains basic impact analysis rules to enable impact analysis and root cause analysis in
UCMDB. These impact analysis rules are templates for more complex rules that you can define based on
business needs.
All impact analysis rules fully propagate both Change and Operation events. For details on impact
analysis, see "Impact Analysis Manager Page" and "Impact Analysis Manager Overview" in the
HP Universal CMDB Modeling Guide.
Note: Impact analysis events are not propagated to Fibre Channel Ports for performance reasons.
FC Port to FC Port
This impact analysis rule propagates events between related fiber channel ports.
FC Switch Devices to FC Switch
This impact analysis rule propagates events from a Fibre Channel Port to and from a Switch. The event
is also propagated to the associated Storage Fabric.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 347 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 15: HP Storage Operations Manager (SOM) Integration
Host Devices to Host
This impact analysis rule propagates events between Fibre Channel HBAs and Hosts, and Logical
Volumes on the Host.
Logical Volume to Logical Volume
This impact analysis rule propagates events on a Logical Volume contained in a Storage Array to the
dependent Logical Volume on the Host.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 348 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 15: HP Storage Operations Manager (SOM) Integration
Storage Array Devices to Storage Array
This impact analysis rule propagates events between Logical Volumes, Storage Processors, Fibre
Channel HBAs, and Storage Arrays.
Reports
The SOM package contains basic reports that can be customized to suit the integrated storage content.
The Change Monitoring and Asset Data parameters are set on each CIT in this package to enable
Change and Asset Reports in Universal CMDB. The following reports are available:
l
"Storage Array Configuration" below
l
"Host Configuration" on the next page
l
"Storage Array Dependency" on the next page
l
"Host Storage Dependency" on page 351
l
"Storage Pool Configuration" on page 351
Storage Array Configuration
This report shows detailed information on Storage Arrays and its sub-components including Fibre
Channel Ports, Fibre Channel Arrays, and Storage Processors. The report lists Storage Arrays with subcomponents as children of the Array.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 349 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 15: HP Storage Operations Manager (SOM) Integration
Host Configuration
This report shows detailed information on hosts that contain one or more Fibre Channel HBAs, Fibre
Channel Ports, or Logical volumes. The report lists hosts with sub-components as children of the host.
Storage Array Dependency
This report maps dependencies on a Storage Array. The report also displays information on switches
connected to it.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 350 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 15: HP Storage Operations Manager (SOM) Integration
Host Storage Dependency
This report shows detailed information on storage infrastructure dependencies of a Host. The report
lists hosts and dependent components.
Storage Pool Configuration
This report shows detailed information on Storage Pool configuration.
Known Issues
This section describes the known issues of the SOM-UCMDB Integration.
l
The SAN host configuration report page shows all switch, host, and storage data.
l
The integration does not currently support NAS devices.
l
For Switch CITs, UCMDB applies the following identification rules:
Nodes are identified using OS identifiers (for example, IP address or Net Bios name) or hardware
identifiers (for example, MAC address or serial number). Two nodes that match the value for at least
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 351 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 15: HP Storage Operations Manager (SOM) Integration
one OS identifier and one hardware identifier are considered to be the same node. Nodes that do
not have such a match and have a conflicting value in either an OS identifier or a hardware identifier
are considered to be different.
o
o
o
OS identifiers include:
l
Name
l
66% of their IP addresses
l
66% of their IP addresses' Authoritative DNS Name
l
Net Bios name
Hardware identifiers include:
l
66% of their interfaces' MAC addresses
l
SNMP system name
l
BIOS serial number
l
BIOS UUID
l
Serial number
l
BIOS asset tag
Two similarly identified nodes are always considered to be different entities for a mismatch of at
least one of the following:
l
l
Operation System Family
l
Cluster Resource Group
UCMDB displays only one port for an NPIV switch.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 352 of 366
Chapter 16: HP Systems Insight Manager
(HP SIM) Integration
This chapter includes:
Overview
354
Supported Versions
354
HP SIM Integration Mechanism
354
How to Discover HP SIM Data Center Infrastructure
357
SIM WebService Ports Job
360
SIM Integration by WebServices Job
361
Instance Views
363
Troubleshooting and Limitations
365
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 353 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 16: HP Systems Insight Manager (HP SIM) Integration
Overview
HP Universal CMDB (UCMDB) can discover data center infrastructure information stored in an HP
Systems Insight Manager (HP SIM) system. Integration involves synchronizing devices, topology, and the
hierarchy of a data center infrastructure in the UCMDB database (CMDB). This enables change
management and impact analysis across all business services mapped in UCMDB, from an infrastructure
point of view.
UCMDB initiates discovery on the HP SIM server through Web service calls. Synchronized configuration
items (CIs) include nodes such as Windows, and UNIX servers, network devices, printers, clusters,
cellular/partitioned systems, blade enclosures, and racks. Some server components, for example, CPU,
are also synchronized. The integration also synchronizes relationships between blade servers and blade
enclosures, virtual machines, physical servers, and so on. The synchronization uses an XML-based
mapping that dynamically changes synchronized CIs and attributes without requiring a code change.
For details on nodes and attributes in HP SIM, refer to the Database tables section of the HP SIM
Technical Reference guide.
Supported Versions
This integration solution supports HP SIM versions 5.1, 5.2, 5.3, 6.0, 6.1, 6.2, 6.3, 7.0, 7.1, 7.2, 7.3, and 7.4
HP SIM Integration Mechanism
DFM uses the HP SIM Web service API to retrieve node information from the HP SIM database. DFM also
enables you to specify extended attributes that should be retrieved for each node.
HP SIM represents hosts (blade enclosures, racks, servers, and so on) as Nodes; UCMDB has separate
CITs for each such host. To represent hosts correctly in UCMDB, a two-level mapping is used, to enable
integration customization without code changes. This makes the integration completely customizable
and dynamic.
For details on jobs, see "Module/Job-Based Discovery" in the HP Universal CMDB Data Flow Management
Guide.
The following sections describe the levels of mapping:
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 354 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 16: HP Systems Insight Manager (HP SIM) Integration
HP SIM Node to HP UCMDB Node Mapping
All IP-enabled systems are represented as Nodes in HP SIM and each node has attributes (for example,
operating device type and operating system name) that can be used to classify nodes as specific CITs in
UCMDB. The first level of mapping involves setting parameters on the SIM Integration job. This job
includes HostCitIdentifierAttributes and HostCitIdentifierMap parameters that are used for the
mapping:
l
HostCitIdentifierAttributes. This attribute specifies the names of HP SIM Node attributes that are
used for the mapping. This parameter uses the DeviceType and OSName out-of-the-box Node
attributes. The parameter accepts comma-separated node attribute names, is case sensitive, and
expects each node attribute name to be enclosed in single quotes.
l
HostCitIdentifierMap. This attribute specifies the mapping between values of the above HP SIM
Node attributes and corresponding UCMDB CITs. This parameter accepts a comma-separated list of
value pairs, where each value pair takes the following format:
'node attribute value':'UCMDB CI Type'
Both attributes are case-sensitive and must be enclosed in single quotes. Each Node-attribute value is
one possible value of one or more Node attribute names specified in the HostCitIdentifierAttributes
parameter. Each UCMDB CIT is the name (not the display name) of the UCMDB CIT to which this value
maps.
This parameter has out-of-the-box mappings as follows:
HP SIM Node Attribute
UCMDB CIT
'AIX'
'unix'
'Complex'
'complex'
'Embedded'
'management_processor'
'Enclosure'
'enclosure'
'HPUX'
'unix'
'Hypervisor'
'unix'
'LINUX'
'unix'
'MgmtProc'
'management_processor'
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 355 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 16: HP Systems Insight Manager (HP SIM) Integration
HP SIM Node Attribute
UCMDB CIT
'Printer'
'netprinter'
'Rack'
'rack'
'Server'
'node'
'Solaris'
'unix'
'Switch'
'switch'
'WINNT'
'nt'
'Workstation'
'node'
Example mapping based on the above settings:
l
If the DeviceType attribute of a node has the value Switch, in UCMDB the node is represented as a
Switch CIT.
l
If the OSName attribute of a node has the value WINNT, in UCMDB the node is represented as an NT
CIT (Display name: Windows).
The DFM script parses these mapping parameters from left to right and does not stop on success, so
the rightmost match is considered final. This means that if a node has DeviceName = Server and
OSName = HPUX, the rightmost match is OSName with value HPUX. The resulting CIT for this node in
UCMDB is unix because HPUX maps to unix.
Node Attribute to CI Type and CI Attribute Mapping
Once the nodes are mapped to CITs using DFM job parameters as described in "HP SIM Node to HP
UCMDB Node Mapping" on the previous page, individual node attributes (including extended node
attributes) are mapped to corresponding attributes (or CITs, as appropriate) using a generic UCMDB
integration framework. The framework uses an XML file in which source and target CIT and attribute
names are specified.
A sample XML mapping file (SIM_To_UCMDB_Sample_MappingFile.xml) that includes all node CITs
mapped in the"HP SIM Node to HP UCMDB Node Mapping" on the previous page section is included in the
SIM_Integration package. The sample file includes host resources (for example, CPU, Disk) and
relationship mapping information, to build relationships between various nodes (for example, Blade
Enclosure to server, virtual machine host to guest, and so on).
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 356 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 16: HP Systems Insight Manager (HP SIM) Integration
Using this framework, you can map additional CITs without any code changes. For example, to map
HBAs, add a new section to the XML file. Define the node attributes that identify an HBA and its
attributes. Relationships between HBAs and HOSTs are also required.
How to Discover HP SIM Data Center Infrastructure
This task describes how to discover data center infrastructure information stored in an HP Systems
Insight Manager (HP SIM) system.
This task includes the following steps:
l
"Prerequisites" below
l
"Perform setup on the Probe machine" on the next page
l
"Enable chunking - optional" on page 359
l
"Run the job" on page 359
1.
Prerequisites
Important: If you set up an HTTPS connection to connect to the SIM WebService API (that is, an
SSL enabled HTTP connection), the SIM Integration job performs no validation of any
certificates presented by the HP SIM server. The job trusts any certificate issued by the HP SIM
server and uses it for SSL enabled communication.
The following additional requirements must be satisfied for the mapping file to be valid for HP SIM
(for details on the mapping files, see "HP SIM Integration Mechanism" on page 354):
o
Verify that source and target are HP SIM and HP UCMDB respectively.
o
Verify that attribute names specified in the HostCitIdentifierAttributes parameter are included
as attributes of each host CIT in the XML file.
That is, the OSName and DeviceType attributes must be included for each host_node
(Computer), chassis (Chassis), netprinter (Net Printer), switch (Switch), nt (Windows), unix
(UNIX), hp_complex (Complex), and management_processor (Management Processor) CIT.
o
Verify that default attributes (that is, non-extended attributes) of a node have a Node. prefix in
the mapping file.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 357 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 16: HP Systems Insight Manager (HP SIM) Integration
That is, you should specify attributes such as OSName, DeviceType, and IPAddress as
Node.OSName, Node.DeviceType, and Node.IPAddress.
o
Verify that each Node CIT has the following attribute mapping to enable the generation of the
host_key attribute:
<target_attribute name="host_key" datatype="StrProp" >
<map type="direct" source_attribute="host_key" />
</target_attribute>
Note: The host_key attribute is the primary key attribute on Node and derived CITs. Since
HP SIM uses a different type of key attribute, the XML definition for the host_key attribute
is included in the mapping file, to enable generation of the host_key primary key attribute.
o
Verify that the IP Address mapping section has the following attribute to enable automatic
population of the IP domain attribute:
<target_attribute name="ip_domain" datatype="StrProp">
<map type="direct" source_attribute="ip_domain" />
</target_attribute>
Note: For details on the list of HP SIM nodes and attributes, refer to the HP SIM
documentation.
2.
Perform setup on the Probe machine
a. Copy mxpartnerlib.jar from this directory:
C:\hp\UCMDB\DataFlowProbe\runtime\probeManager\
discoveryResources\hpsim
to this directory:
C:\hp\UCMDB\DataFlowProbe\content\lib
b. Open C:\hp\UCMDB\DataFlowProbe\bin\WrapperEnv.conf for editing.
c. Comment out line ~51 with a hash sign (#) at the beginning so that it looks as follows:
#set.SYSTINET_CLASSES=%lib%/webservice;.........
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 358 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 16: HP Systems Insight Manager (HP SIM) Integration
d. Save and close the file.
e. Restart the Probe.
3.
Enable chunking - optional
If the HP SIM server being discovered contains or manages a large number of nodes (more than
1,000), you should consider enabling chunking (Data Flow Management > Adapter Management >
select an adapter > Adapter Management tab > Adapter Parameters pane):
a. To reduce load on the SIM server, if necessary, you can set the ChunkSize parameter in the
SIM Integration adapter to a lower value than the default 500.
b. Populate the dbIP parameter in the SIM Integration adapter with the IP address of the HP SIM
CMS database.
c. Populate the SIM Database ... fields in the HP SIM protocol with connection details for the
HP SIM CMS database.
Note: HP SIM CMS database details (except for the password) are located in the Systems
Insight Manager\config\database.props file on the HP SIM server.
4.
Run the job
Note: For details on running an integration job, see "Integration Studio" in the HP Universal
CMDB Data Flow Management Guide.
In the Integration Studio, create a new integration point.
a. Provide a name and description for the integration point.
b. Under Integration Properties > Adapter, select the Systems Insight Manager adapter.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 359 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 16: HP Systems Insight Manager (HP SIM) Integration
c. Complete the dbIP field with the IP address of the HP SIM CMS database.
d. Under Adapter Properties > Data Flow Probe, select the Data Flow Probe.
e. Under Adapter Properties > Trigger CI instance select:
i. Select Existing CI (if you have a valid, existing CI). The Select Existing CI pane appears.
Select the CI or
ii. Create New CI (if you need to create a new CI). The Topology CI Creation Wizard appears.
Complete the creation of the CI using the Wizard.
Note: For details on the Topology CI Creation Wizard, see "Topology CI Creation Wizard" in
the HP Universal CMDB Data Flow Management Guide.
f. Save the integration point.
g. Run the job.
SIM WebService Ports Job
Trigger Query
Adapter
l
Input query:
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 360 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 16: HP Systems Insight Manager (HP SIM) Integration
Discovered CITs
l
Composition
l
Containment
l
IpAddress
l
IpServiceEndpoint
l
Node
l
Usage
SIM Integration by WebServices Job
This section includes details about the job.
Trigger Query
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 361 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 16: HP Systems Insight Manager (HP SIM) Integration
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 362 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 16: HP Systems Insight Manager (HP SIM) Integration
Discovered CITs
l
Chassis
l
Composition
l
Computer
l
Containment
l
Cpu
l
Dependency
l
Enclosure
l
HP Complex
l
Interface
l
IpAddress
l
LogicalVolume
l
Management Processor
l
Membership
l
Net Printer
l
Node
l
Process
l
Rack
l
Switch
Instance Views
The package includes two adapter views that show all nodes and resources retrieved from HP SIM, as
well as relationships between these nodes.
This section includes the following topics:
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 363 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 16: HP Systems Insight Manager (HP SIM) Integration
l
"Host Infrastructure View" below
l
"Hosts and Resources from HP SIM" on the next page
Host Infrastructure View
This view shows relationships between Chassis, Blade Enclosures, Servers, Workstations, Virtual
Machine hosts to guests, and so on. This view also shows the interdependence between various nodes in
an environment, to enable change management and correlation.
You can use this view, for example, to identify all the servers housed within a specific blade enclosure
and all virtual machines running on servers within this blade enclosure. This enables analysis of the
impact of shutting down a blade enclosure (say, for a firmware upgrade) on virtual machines. If UCMDB
knows of services provided by these virtual machines and which business service these services are part
of, it becomes possible to analyze the impact of a blade enclosure outage all the way to a business
service.
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 364 of 366
Universal Discovery Content Guide - HP Integrations
Chapter 16: HP Systems Insight Manager (HP SIM) Integration
Hosts and Resources from HP SIM
This view shows Node CIs retrieved from HP SIM with associated HostResource and NetworkResource
CIs also retrieved from HP SIM.
Troubleshooting and Limitations
This section describes troubleshooting and limatations for HP SIM integration.
Note: The following limitation only applies when (a) using UCMDB Version 9.00-9.03, and (b) the user
manually increased the out-of-the-box value in the pattern execution option maximum threads to
greater than 1.
Limitation: If there are multiple HP SIM servers in the environment and this integration is used to
integrate with all of them, you should create a new integration job for each HP SIM server and schedule
them to run separately. This is because the integration uses XML files to process results from HP SIM,
and running the integration against multiple HP SIM servers simultaneously causes the XML files to be
overwritten (because the file name is static).
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 365 of 366
Universal Discovery Content Guide - HP Integrations
Send Documentation Feedback
Send Documentation Feedback
If you have comments about this document, you can contact the documentation team by email. If an
email client is configured on this system, click the link above and an email window opens with the
following information in the subject line:
Feedback on Universal Discovery Content Guide - HP Integrations (Universal CMDB Content Pack
17.00 (CP17))
Just add your feedback to the email and click send.
If no email client is available, copy the information above to a new message in a web mail client, and
send your feedback to cms-doc@hp.com.
We appreciate your feedback!
HP Universal CMDB (Content Pack 17.00 (CP17))
Page 366 of 366
Download PDF
Similar pages