Edge Documentation

{{DISPLAYTITLE:SolarWinds Orion NPM pimB}}
[[Category:Integrations]]
This page documents the enPortal integration for SolarWinds Orion NPM. 

* <b>Vendor</b>: SolarWinds
* <b>Product</b>: Orion NPM
* <b>Supported Version(s)</b>: 10.4.2
* <b>Name of enPortal Integration Package</b>: solarwinds.orion.npm_pimB
* <b>Required enPortal Version</b>: 4.6.1 and above


The following section documents supported platforms, installation, and configuration of the Orion NPM Product Integration Module on enPortal versions 4.6.1 and above.

== Support Matrix ==
The following Operating System, Database, and Web Browser platforms are supported:


=== Operating System ===
Please see the list of supported Operating Systems on the [[System_Requirements|System Requirements]] page.


=== Database ===
A special database is not required to implement this integration module.  The AppBoard/enPortal database is used to store all configurations related to this integration module.


=== Web Browser ===
Please see the list of supported Web Browsers on the [[System_Requirements|System Requirements]] page.


== Installation ==

Perform the following steps to install the Orion NPM PIM:
# Install AppBoard/enPortal as detailed in the [[Installation|Installation]] documentation
# Download the file solarwinds.orion.npm_pimB.jar
# Start enPortal and login as an administrator
## User Name: administrator
## Password: administrator
## Domain: System
# Under the <b>Advanced</b> tab, select <b>PIMImport</b>
# Click the <b>Browse...</b> button
# Locate the Orion NPM PIM JAR file in the Open dialog
# Click the <b>Start</b> button to extract the files from the PIM .jar archive
# Under the <b>Advanced</b> tab, select <b>XMLImport</b>
# Click the <b>Start</b> button to load the PIM into the system
# Confirm that the following message is displayed: "Import completed; loaded the following file(s): load_solarwinds.orion.npm_pimB.txt"
# Under the <b>Advanced</b> tab, select <b>Explore System</b>
# Navigate to the /Directory/system/proxy/ folder and locate the “Manage Proxy” channel
# Right-click on the “Manage Proxy” channel and select <b>Open</b> to launch the channel
# In the Manage Proxy tool, click “Reset All”
# Refresh the browser


== Integration Details ==
The following sections provide special details for configuring the integration module after installation.


=== Channel Types ===

* Home - Channel that displays the default Home page for the logged in user, including full navigation controls (no custom configuration required)

* HomeView - Channel that displays the Home Tab of the application

* View - Channel that displays a tab/page of the application. Available tab/page options are Home, Network, Applications, Configs, Virtualization, Netflow. A set of pre-built channels are included to show each tab/page directly.

* Proxy - Channel that is used by the system to display Orion NPM channels (no custom configuration required)




=== Configuration ===

After installing the Orion NPM PIM, perform the following steps to configure access to the host Orion NPM server:

# Click on the <b>Applications</b> tab
# Right-click on the name "sample" in the row for Solarwinds and select "Modify"
# Fill in the items in the <b>Modify Application Wizard</b> dialog:
## Select the protocol used to access your Orion NPM server (http or https)
## Change the host name from "changeme" to the hostname or ip address that will resolve to your Orion NPM server
## Change the port to the port number of your Orion NPM server
## Click "Save" to keep your changes
# Click on the <b>Integrations</b> tab
# In the Explorer, under Packages, expand the solarwinds.orion.npm_pimB tree and click on the <b>Sample</b> target.  Confirm that the information you entered is displayed for your Orion NPM server
# Under the <b>Sample</b> target, click on the <b>Home</b> channel.  A login prompt should be displayed.
# Log in using the same credentials you would use for accessing the Orion NPM application in a browser.  Confirm that the Orion NPM Home page is displayed.


=== Create Channels ===

After installing the Orion NPM PIM and configuring access to the host Orion NPM server, perform the following steps to create channels to display Orion NPM content:

# Click on the <b>Applications</b> tab
# Right-click on the name "sample" in the row for Solarwinds and select a channel type
# In the "Channel Name" box, enter the name you want to give to the new channel
# For "Channel Type", select "3rd Party Pims"
# Click <b>Next</b>
# Click <b>Finish</b>
# Click on the Integrations tab
# In the Explorer, under Packages, expand the solarwinds.orion.npm_pimB tree and click on the Sample target. Confirm that the new channel is listed along with the other sample channels.


Repeat the above steps to create additional channels.  Select a different Channel Type in step 2 to create a different type of channel.


=== Known Issues ===

The following known issues are associated with this PIM:

*There are currently not any known issues associated with this PIM


=== License Usage ===

In order for the AppBoard/enPortal administrator to configure the solarwinds.orion.npm_pimB PIM, the AppBoard/enPortal license.properties file must include licensing for at least one solarwinds.orion.npm_pimB server.  The administrator can create one additional host ("target") in AppBoard/enPortal for each server license included in the license file.

Each AppBoard/enPortal user maintains one user session with the Orion NPM server.  The Orion NPM application must be licensed to support the number of users that will be accessing the application through AppBoard/enPortal.


=== Version Support ===

The following matrix details the supported Orion NPM and compatible AppBoard/enPortal versions:

{| class="wikitable" border="1" style="background-color:#eeeeee;"
|+ align="bottom" style="color:#e76700;" |''Version Support''
|-
! width="150" | Package Name
! width="150" | enPortal Version
! width="150" | Orion NPM Supported Versions
|-
| solarwinds.orion.npm_pimB
| 4.6.1+
| 10.4.2
|}

{{Tip|To see the current enPortal version, run the <tt>portal version</tt> command from the <tt>[AppBoard_Home]/server/bin</tt> directory.}}


== Orion NPM Upgrades ==

=== Upgrading from an older version of Orion NPM ===

Older versions of Orion NPM are not supported by this PIM, so this upgrade path is not supported.  It is recommended that you validate the PIM in your Orion NPM environment to confirm that it supports the required functionalities. 


=== Upgrading Orion NPM to a newer version === 

Perform the following steps when the Orion NPM server is upgraded to a newer version of Orion NPM:

# Check the AppBoard/enPortal PIM online documentation to see if the new Orion NPM version is supported by the existing solarwinds.orion.npm_pimB PIM.
## To test if the new Orion NPM version is supported by the existing PIM that you have installed, perform the following steps:
### Click on the <b>Applications</b> tab
### Right-click on the row for the old Orion NPM server and select "Modify"
### Update the protocol, host, and port to reference the server where the new version of Orion NPM is running
## If the new Orion NPM version is not supported by the existing PIM that you have installed, perform the following steps to upgrade the PIM:
### Download the new PIM version from the PIM download site
### Follow the steps in the Installation section above to install and configure the new PIM version
### Re-create all Orion NPM channels to reference the new PIM
### [Optional] Perform the steps outlined in the Uninstall section below to remove the old PIM from the system


== Uninstall ==

{{Warning|Uninstalling the solarwinds.orion.npm_pimB PIM will break all of the channels in your AppBoard/enPortal system that reference this integration.}}

Perform the following steps to uninstall the solarwinds.orion.npm_pimB PIM:

# Click on the <b>Integrations</b> tab
# In the Explorer, under Packages, locate the solarwinds.orion.npm_pimB integration
# Right click on the integration name, and select "Delete"
# Click "Ok" to confirm that you want to delete the integration package