webservices_rest APIs

This article details the full process for implementing webservices_rest.
uimpga-ga
This article details the full process for implementing webservices_rest.
Contents
Ensure that you meet the following minimum requirements for webservices_rest:
UIM Server
  • Nimsoft Server v5.1 or later.
  • Infrastructure Manager v3.84.2 or later.
Unified Management Portal (UMP)
  • UMP v2.5.1 or later.
The webservices_rest probe is updated to run with the latest CA UIM database schema. When updating UIM, be sure to download the webservices_rest probe with the corresponding version number. Do not download webservices_rest with a later version than your CA UIM: doing so may break endpoints.
Deploy the webservices_rest Package
Follow these steps:
  1. Download the 
    webservices_rest 
    package from the Web Archive to the hub's local archive.
  2. Deploy the 
    webservices_rest
     package from the local hub archive to a robot running the 
    wasp
     probe.
The 
wasp
 probe will restart. You can monitor the restart process in the deployed probes list or the log file. When wasp has restarted, you can use the webservices_rest tool.
Note: The webservices_rest tool functionality is updated with wasp probe functionality, and the wasp probe is updated with each new version of CA UIM. We recommend that you update the webservices_rest tool when you update CA UIM and UMP.
(Optional) Enable Slash Characters
The default configuration of the Tomcat server that serves as the platform for UMP does not allow encoded forward-slash characters (“/”) or backward-slash characters ("\") in URLs. To avoid problems (for example, when requesting QoS metrics that contain a slash in the name), you will have to add an extra Java startup object to the wasp probe.
Follow these steps:
  1. Open the 
    wasp
     configuration GUI.
  2. Click the 
    wasp 
    node.
  3. Enter the following argument in the 
    Extra JVM arguments 
    field.
    -Dfile.encoding=UTF8 -Dorg.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true -Dorg.apache.catalina.connector.CoyoteAdapter.ALLOW_BACKSLASH=true
    The parameters in the 
    Extra JVM arguments
     field are separated by spaces. The screen capture below shows what the
    Extra JVM arguments
    field looks like when more than one parameter is defined: 
    wasp_configuration.JPG
The wasp probe restarts after you save your configuration. 
Test the Deployment
Browse to the following address:
http://<your_UMP_address>/rest/version-info
If the web services are running correctly, you should see version information for the web services:
Nimsoft RESTful web services interface version x.x
Some browsers (such as Google Chrome) do not directly display this text, but instead show an error message such as
Empty Document
. To see the text, right-click the page and select
Show Page Source
.