Use the request.cfg file for automatic installation of probe packages in DX UIM

Products

DX Unified Infrastructure Management (Nimsoft / UIM)

Issue/Introduction

The request.cfg file is used for automatic installation of probe packages and monitoring configuration but there are no detailed instructions on what is required in this file.

How is the request.cfg file configured and used when doing automatic installation of probe packages?

How do I use request.cfg ?

request.cfg instructions

Environment

DX UIM 23.4.*

Cause

Guidance / Instructions

Resolution

To use the request.cfg:

1. create a simple text file called 'request.cfg' and place it in the Nimsoft directory of the robot.

- /opt/nimsoft/ on Linux
- C:\Program Files (x86)\Nimsoft\ on Windows

2. The general format is shown below:

<distribution request>
packages = cdm, processes, custom-0815, superpack123
</distribution request>

3. Restart the robot

Notes:

- Specify the probe packages that need to be deployed. It supports any package, including custom superpackages.
- The robot will pull specifically referenced probes or superpackages down when the Robot starts up.
- Be sure that the hub managing the robot has access to a local distsrv probe.
- request.cfg also supports auto-(re)initialization by adding the following key and value to the file:
  expect_ip_change = yes

How does it work?

When the robot starts up, it looks for a file called 'request.cfg' in the Nimsoft directory. The package requests are submitted to the distsrv probe, or ADE (Automatic Deployment Engine) probe.
To perform a complete installation of a Robot and a set of packages, prepare a request.cfg file and copy it to the intended Nimsoft installation directory. then install the Nimsoft Robot.
A script can start and stop a robot but a script cannot push the request.cfg as this is a built-in function of the robot. If the request.cfg is in the correct location (and has no mistakes in the file contents) - when the robot starts and the robot is in good working condition, it will recognize the existence of the request.cfg file and process it.

Additional Information

Is it possible to specify the path to distsrv in request.cfg?

Yes,

<distribution request>
distsrv = /<domain>/<hub>/<robot>/distsrv

where you replace the following parts of the UIM address of the distsrv probe you want to use with the following:

<domain> = UIM domain name
<hub> = hub name
<robot> = hub robot name

Note that the DX UIM address specified is case-sensitive. For example, my_uim_domain is not the same as my _UIM_domain.

Can I use request.cfg to deploy a super package to apply changes to multiple probes?

Yes, the request.cfg can also deploy a superpackage during its operations as well - just specify the superpackage name in the list of packages in the request.cfg file.

Can I use the automated_deployment_engine (ADE) probe to deploy packages with the request.cfg file?

Upon startup, the robot/controller looks for request.cfg, a user-created text file that enables automatic deployment of the probes specified in that file to the robot. These requests are facilitated by thhe distsrv, which handles them by default.

To have a robot direct the requests to ADE, use the Raw Configure utility to add the deploy_addr parameter to the robot.cfg for the robot which is going to receive the request.cfg, and specify the UIM NimBUS address of the ADE probe:

deploy_addr=/<domain>/<hub>/<robot>/automated_deployment_engine

This will cause the robot, upon noticing the request.cfg, to try the ADE first; if this fails it will fall back to trying distsrv.

Can I specify a particular version of a probe or package in the request.cfg file
- The distsrv (or the ADE probe if configured) will deploy the highest version of a standard probe package from the archive of the nearest hub archive to the robot where request.cfg is placed.
  So, if you have, for instance, ad_server 2.06, 2.05, 2.6T1, 2.10, it will automatically install 2.10.
- To define a certain version the following format can be used:
  
  packages = pkgname1:version, pkgname2:version
- The condition to achieve this is forcing request.cfg to use ADE as described above.
  
  Example:
  
  you can use:
  
  <distribution request>
  packages = ad_server:2.05
  </distribution request>To deploy the specific version (ad server 2.05) from the archive.
  
  NOTE: FROM DX UIM 23.4CU6
  
  Starting DX UIM 23.4.CU6, by using the robot_update delivered in that CU, the request.cfg will fully work with ditsrv for single or multiple version specific packages.
  
  For example using a request.cfg like:
  
  <distribution request>
  packages = ad_server:2.05,cdm:8.01,cisco_ucm:2.05
  </distribution request>
  
  And just running the enhanced robot_update and without any additional key, it will use distsrv dy default and those specific versions will be deployed.

Techdocs:

automated_deployment_engine (ADE)

Bulk Deployment