How to Pull Data Topology from an HPE NA Server using a Java Client

Search for	Example	Results
A single word	`cat`	Topics that contain the word "cat". You will also find its grammatical variations, such as "cats".
A phrase. You can specify that the search results contain a specific phrase.	`"cat food"` (quotation marks)	Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase.

Search for	Operator	Example
Two or more words in the same topic	`AND` `and` `+` (plus symbol) `&` (ampersand)	`cat AND dog` `"cat food"+milk` `"cat food"&"dog food"`
Either word in a topic	`OR` `or` `\|` (pipe)	`cat OR dog` `cat \| dog`
Topics that do not contain a specific word or phrase	`NOT` `not` `!` (exclamation point)	`NOT cat` `! dog`
Topics that contain one string and do not contain another	`^` (caret)	`cat ^ mouse`
A combination of search types	`( )` parentheses	`cat + (dog \| mouse)` `cat \| dog + (! mouse)`

The HPE 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 HPE NA server to the UCMDB using a Java client.

Integration Flow

(This step is for NA 10.10 or later) To support NA 10.10 or later, do the following:
1. Create a new folder naxxxx (for example, na1010) under the <probe>\runtime\probeManager\discoveryResources directory.
  
  Note xxxx is the NA version number.
2. Copy the following two JAR files from the <probe>\runtime\probeManager\discoveryResources\na directory to the <probe>\runtime\probeManager\discoveryResources\naxxxx directory :
  - ddm-na-client.jar
  - fst.jar
3. Copy the following NA 10.10 (or later) JAR files to the <probe>\runtime\probeManager\discoveryResources\naxxxx directory:
  - bcprov-jdk150on.jar, cryptojce.jar, cryptojcommon.jar, and jcmFIPS.jar in the <NA Installation DIR>/jre/lib/ext directory.
  - truecontrol-client.jar in the <NA Installation DIR>/client directory.
  - json.jar in the <NA Installation DIR>/server/ext/jboss/server/default/lib directory.
4. Result
  
  The <probe>\runtime\probeManager\discoveryResources\naxxxx directory includes the following files:
  - bcprov-jdk15on.jar
  - cryptojce.jar
  - cryptojcommon.jar
  - ddm-na-client.jar
  - fst.jar
  - jcmFIPS.jar
  - json.jar
  - truecontrol-client.jar
Create a new integration point in the Integration Studio based on the Pull Topology from HP Network Automation adapter as follows:
1. In UCMDB, go to Data Flow Management > Integration Studio.
2. Click the New Integration Point button. The New Integration Point dialog box opens.
3. Enter a name and description for the adapter.
4. Check the Is Integration Activated check box.
5. In the Adapter field, click the Select Adapter button. The Select Adapter dialog box opens.
6. Go to HP Software Products > HP Network Automation, select Pull Topology from HP Network Automation, and click OK.
7. 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.
  - Credentials ID. Click the Select Credentials ID button and in the Choose Credentials dialog box enter the HPE NA Java protocol credentials to be used for connection.
  - 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.
  - 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 or later, replace the value of the remoteJVMClasspath with the following:
    
    ../runtime/probeManager/discoveryResources/naxxxx/*;%minimal_classpath%
  - reportDeviceConfigs. This parameter specifies whether the latest configuration of devices should be reported as configuration_document CIs. The default value is false.
  - runInSeparateProcess. This parameter enables the job to run in an external JVM process, separate from the main probe process. The default value is true and this value should not be changed.
  - 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.
  - Trigger CI instance. This parameter defines the IP Address of the target HPE NA server.
8. Click OK in the New Integration Point dialog box.
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:
1. Establishes a connection to the target HPE NA server.
2. Performs a query to retrieve IDs of all devices in the system.
3. Retrieves all devices in chunks. The default chunk size is 500 devices.
4. 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.
5. Retrieves all device modules. Depending on the value of parameter queryTopologyPerDevice, the device modules are retrieved per device or from all devices at once.
6. Retrieves all VLANs.
7. Retrieves connections between devices. Depending on the value of parameter queryTopologyPerDevice, the connections are retrieved per device or from all devices at once.
8. Retrieves configuration of each device as textual data (if reportDeviceConfigs=true).
9. Analyzes topology. Port channels are identified with related child ports, port aliases are identified along with the parent port.
10. 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.