CA UIM - Perl SDK

CA UIM - Nimsoft - Perl SDK Documentation

The main goal of this git is to provide a perl SDK documentation with a better visibility on all API and community works. It give a new way for the community to contribute if any problems are spotted too.

For a better experience find the web version Here

Overview and vocabulary

The Perl SDK modules wrap the Nimsoft Message Bus API functions, easing the development of probes that are written in Perl.

Convensions used when prototyping the functions

rc is the Return Code (integer)

Starter guides

API

When you use API for a Perl script that will be executed on a terminal (so not packaged to be executed as a deamon or a timed probe). You will have to login to the NimBus to not encounter Authentification errors.

Code examples

Troubleshooting

Symptom: Scripts halt with an error message similar to:

Can't locate Nimbus/API.pm in @INC (@INC contains: /usr/local/lib/perl5/sun4-solaris/5.00404 /usr/local/lib/perl5 /usr/local/lib/perl5/site_perl/sun4-solaris /usr/local/lib/perl5/site_perl .) at subex.pl line 1.
BEGIN failed--compilation aborted at subex.pl line 1.

Possible causes:

  1. The perllib directory structure is not reachable for Perl
    • Add PERL5LIB to your environment (for example PERL5LIB = /opt/nimsoft/perllib)
    • Add use lib (“/opt/nimsoft/perllib”) to your script header (before use Nimbus::API)
  2. Perl Extensions for Nimsoft are binary incompatible with the distribution
    • Get a compatible Perl distribution (or contact Nimsoft support).

Symptom: You are unable to locate the perllib directory on the file system.

Possible causes:

  1. The Nimsoft runtime libraries for Perl have not been installed
    • Install the runtime libraries
  2. They do not reside under the root installation directory for Nimsoft
    • WIN32: c:\program files\Nimsoft\perllib
    • UNIX: /opt/nimsoft/perllib.

Know defects

Community Frameworks