NAM Console Public REST API - Software Services

Applies to NAM 2019

The best way to configure one software service in NAM is through the NAM Console.

To efficiently configure multiple software service configurations, however, you need to use API calls. The NAM Console Public REST API - Software Services enables you to manage the configuration of software services in NAM.

You can:

Note

When managing NAM software services using the API, remember the following:

  • The payload for software services is in XML (not JSON).
  • The API manages user-defined software services (not auto-discovered software services).
  • All changes you perform with /config/softwareservices create a configuration draft that you then need to publish using a POST /config/device/{device}/draft call.

For editing guidelines, see Editing NAM Console software services xml.

Use cases

Use case 1: Create a new software service definition

You have deployed a new application in the monitored environment. It is similar to an existing application, so you want to reuse an existing monitoring configuration as much as possible rather than create one from scratch.

  1. Use GET /config/softwareservices/{name} to download the configuration of an existing software service.
  2. Edit the downloaded configuration file to give it a new service name, new IP address, and optional additional changes for our new software service.
  3. Use POST /config/softwareservices to create a new software service.
  4. Optional: use the NAM Console to verify that everything is as expected.
  5. Use POST /config/device/{device}/draft to publish the new configuration.

Use case 2: Update an existing software service definition

An existing software service in your environment has been moved to another server, which means the software service definition has to be updated if you want to continue to effectively monitor the service.

Information describing the change (which service, what is new server IP address) is available in CMDB.

  1. Use GET /config/softwareservices/{name} to download the configuration of an existing software service.
  2. Update (if possible, automatically) the configuration file with the new IP address using a value from CMDB.
  3. Use PUT /config/softwareservices/{name} to update the software service.
  4. Optional: use the NAM Console to verify that everything is as expected.
  5. Use POST /config/device/{device}/draft to publish the new configuration.

Use case 3: Update multiple software service definitions

You have multiple software services based on the HTTP analyzer, and you have not previously analyzed them all deeply, but now you have the need and resources to reconfigure them all to use ADoD to get details down to the level of hits and headers.

  1. Determine the XML tags responsible for ADoD data generation within an HTTP software service definition.
    1. In the NAM Console, update and save the software service for ADoD.
    2. Get an after image of the software service configuration.
    3. Compare to see where the configuration file needs to change.
  2. Use GET /config/softwareservices to get a list of user-defined HTTP-based software services in your system (optionally with given prefix in its name).
  3. For each software service from the list:
    1. Use GET /config/softwareservices/{name} to get configuration details of a software service.
    2. Update the configuration (using the tags we determined in the first step).
    3. Use POST /config/device/{device}/draft to publish the new configuration.