Having problems with your account or logging in?
A lot of changes are happening in the community right now. Some may affect you. READ MORE HERE

A Step by Step Guide for Operations Orchestration - Network Automation Integration

Micro Focus Frequent Contributor
Micro Focus Frequent Contributor
4 0 1,911

Co-authored by Traian Vila

Operations Orchestration (OO) provides automation of end to end IT processes, and the Network Automation (NA) automates configuration, change, and security compliance across the enterprise network. By integrating both of these tools, you can easily define and automatically execute IT processes which can quickly provision, configure or make any changes in your enterprise network, making it faster, and error free.

This step-by-step guide details the process which can be followed to make this integration work seamlessly. We also list example use cases which can be built using this integration.

This article assumes that you have administrator-level knowledge of the Network Automation software, with a working knowledge of the NA command line interface (CLI) in particular.

Before we proceed, please note that this document provides a process with certain assumptions and we strongly recommend to refer and use official product documents for details. Also, the blog provides references for a specific version of the product, and you shall look at the equivalent documentation available for the version of products deployed in your environment.
Blog1_pic1.jpg
 A typical architecture with NA and OO deployed

Procedure to build NA flows
There are two methods of building NA flows in Operations Orchestration:

  1. Use the NA operations provided by the OO Micro Focus Solutions Content Pack
  2. Use the NA flows exposed by the NA API WSDL

 

1. Use the NA operations provided by the OO Micro Focus Solutions Content pack

The Micro Focus Marketplace offers Operations Orchestration 10.x Content for integrating with other Micro Focus products such as Micro Focus Application Lifecycle Management, Micro Focus Operations Manager-i, Micro Focus Network Automation, Micro Focus Network Node Manager and many more.

Download and Import the OO Micro Focus Solutions Content pack from Marketplace into OO Studio https://marketplace.microfocus.com/itom/content/oo-micro-focus-solutions-content

 This Micro Focus Solutions Content pack shall be imported into OO Studio.Blog1_pic2.jpg

The integration for NA 10.x uses the NA Java API, which requires that NA has the SOAP Web service available and running (default).
In all versions of the NA integration, a Java Remote Action Service (RAS) must be installed that can access the targeted NA core(s).

2. Use the NA flows exposed by the NA API WSDL

The Web Services wizard creates OO flows based on the API described in the Web Service Definition Language (WSDL) of the web service that you identify. When integrating NA with Operations Orchestration (OO), import the NA WSDL into the OO Studio wizard. NA WSDL can be found at:

<NA_HOME>\client\sdk\api.wsdl.axis2 [Windows]
<NA_HOME>/client/sdk/api.wsdl.axis2 [Linux]

The NA WSDL exposes a higher number of OO flows comparing to the content pack. Also, when a new version of Network Automation is released and the integration content does not support the new version, you can use the Web Services Wizard to create new OO flows. Here is the detailed procedure:

  • Run the in OO Studio the wizard script: C:\Program Files\Hewlett Packard Enterprise\HPE Operations Orchestration\studio\tools\ws-wizard
    Blog1_pic3.jpgBlog1_pic4.jpg
  • Import the project in OO Studio
    Blog1_pic5.jpg
  • Add the Base CP dependency

Blog1_pic6.jpg

  • Import the NA CA-signed certificate in the OO. The detailed procedure is available at https://docs.microfocus.com/OO/10.70/Content/Administer/SecurityHardeningGuide/Import_Certificate_to_Debugger.htm
    [Please choose the relevant documentation based on your version of OO]

    Note: Although it is recommended to use CA-signed certificates with your applications, to accommodate an NA self-signed certificate in OO, do the following:
  • Edit the Studio.l4j.ini file from <installation dir>/studio
  • Set the option: -Dssl.support-self-signed=true.
  • Restart the OO Studio afterward.

     These steps should help in building the integration and now as we have integration done, below is the simple use cases to demonstrate the same, using both of the integration procedures described above.

Use Cases #1: Add Device by IP

Here we will build a simple flow that would add a new device in Network Automation using it IP Address.


1. Using the NA operations provided by the OO Micro Focus Solutions Content pack:
Below is the process to achieve this use case by using "Add Device By IP" provided
 
Blog1_pic7.jpg
The successful result should contain the newly created NA deviceID:
Blog1_pic8.jpg
 

2. Using the NA API WSDL flows
Comparing with the above Micro Focus Solutions Content Pack based operation, we need an initial login on the web service host (NA server) and share the sessionID with the rest of flow operations.
Hence the similar “Add Device By IP” WSDL flow would look like below:

Blog1_pic9.jpg

Assign the login operation text result field (which is the sessionID) to a variable called "sessionID":
Blog1_pic10.jpg
Pass the value into the add device operation:

Blog1_pic11.jpg
The flow result should return the deviceID in the SOAP response:
Blog1_pic12.jpg
 
How to launch the NA flows

Use OO Central
Once you have the flow ready and properly tested in Studio, export it as a Content Pack (CP) and deploy it into the OO Central. To export a project in OO studio into a content pack follow the steps described at: https://docs.microfocus.com/OO/10.70/Content/Use/UseStudio/Creating_Content_Pack.htm

 To deploy the above CP into OO Central follow the steps described at: https://docs.microfocus.com/OO/10.70/Content/Use/UseCentral/Deploying_cp.htm
 Blog1_pic13.jpg

Use Network Automation
NA also offers the option to launch OO flows directly from the NA Web UI in two ways:

  • Running a Change Plan task that would trigger the OO flow in OO Central
  • Using the Process Automation NA device menu – this will login into OO and launch the selected flow in a guided mode

    Consider the following flow deployed into the OO Central; we will use it to show both ways of running it from Network Automation:
    Blog1_pic14.jpg
     
    1. OO Flow triggered by an NA Change Plan
  • Create a new Change Plan and a simple Change Script that would trigger the OO flow: On NA UI, Go to Devices -> Device Tools -> Change Plans -> New Change Plan

Blog1_pic15.jpg

  • Create a new Advanced Change Script of language "Flow" which contains a REST execute a call to OO Central:
    /PAS/services/http/execute/Library/<path to flow>?flowvariable=value,flowvariable2=value2

Blog1_pic16.jpg

  • Configure the Operations Orchestrations Authentication setup:
    Go to Admin -> Administrative Settings -> User Authentication -> Operations Orchestrations Authentication

Blog1_pic17.jpg

  • Run the change plan against a device
    Note: As designed in NA, a Change Plan task needs run against a device or device group. In this example, the OO flow would add a new device so we can use any device from Inventory.

Blog1_pic18.jpg

  • Go to OO Central UI -> Run Management –> Run Explorer - notice the successful flow triggered from NA

Blog1_pic19.jpg


   2. OO Flow triggered by the NA Process Automation menu

  • Go to NA Operations Orchestrations Authentication setup and add the above flow as shown below
    Note: replace the flow UUID accordingly as displayed in OO Central

 Blog1_pic20.jpg

  • Select any device from inventory and go to Edit – Process Automation
     Blog1_pic21.jpg

    Use a REST service
    Using the various REST-based services, you can use the following URL syntax to interact with HP OO Central via the OO REST service.
    For detailed information about OO API consult the API guide: https://docs.microfocus.com/OO/10.70/Content/Develop/API/REST_APIs.htm

 

Hope this would help. Leave comments if you have any question, comment or suggestion.

All the best.

The opinions expressed above are the personal opinions of the authors, not of Micro Focus. By using this site, you accept the Terms of Use and Rules of Participation. Certain versions of content ("Material") accessible here may contain branding from Hewlett-Packard Company (now HP Inc.) and Hewlett Packard Enterprise Company. As of September 1, 2017, the Material is now offered by Micro Focus, a separately owned and operated company. Any reference to the HP and Hewlett Packard Enterprise/HPE marks is historical in nature, and the HP and Hewlett Packard Enterprise/HPE marks are the property of their respective owners.