Skip navigation
Share:|

Users are integrating PATROL with BPPM, but the big question seems to be what to do with custom KMs.

 

The best reference is our Webinar on Custom KMs and BPPM - If you missed the Webinar, you can view the details here BMC ProactiveNet Performance Management (BPPM) 9.5 Best Practices Webinar Series

 

The details are also available in our online help documents

For information about building a KM, see Building a PATROL Knowledge Module Developers Guide.

Before you begin

Here’s an overview of the workflow for setting up custom KMs in BPPM

Enable custom KMs for BPPM 9.5 in three major phases in the order listed

Data Collection Enablement

Policy Configuration Management Enablement

Menu Command Enablement

  

Test and validate results of each phase before moving on to the next phase

Optional or Phased Enablement

If not enabling, Policy Configuration Management Leverage rules in the Configuration Variables section of a monitoring policy or leverage PATROL & PCM

 

The KM can still collect data into the BPPM 9.5 server

General recommendation is to enable all that is necessary & possible

 

Required tools

BPPM 9.5 Server with CMA installed and operational

BPPM 9.5 Integration Service node installed and operational

PATROL Classic Console version 3.6.00.1or higher

BPPM 9.5 PATROL Agent installed and integrated with the BPPM 9.5 infrastructure

PATROL Common Installer Generator Utility (PCIG)

A common compression utility such as zip delivered with RHEL 6.4

Configure and setup all tools as you normally would.

 

NOTE:

All of these tools should be installed in a development environment.

Do not attempt to configure KMs for BPPM 9.5 in a production environment

Do not install or use other tools in the development environment that may interfere with the development process.

 

  • Older PATROL Classic Console versions
  • Older BPPM infrastructure components
  • PATROL Central Consoles

 

You can find the PCIG tool installer in the installation utility\bmc_products\tools\pcig directory of the BMC Installation Utility installer, version 9.6.

You can also go to  ftp://ftp.bmc.com/bmc/bppm/repo  and review the docx file.

 

To start using the PCIG tool for creating a BAP image for custom KMs, perform the following steps:

1. Copy the downloaded file and the product (KM) in a temporary folder.

For more information, see Downloading the product.

 

2. Extract the installation utility folder and the custom KM folder for which you want to create the BAP image.

The executable files, pcig-32.exe or pcig.l22 (for 32-bit Microsoft Windows or Linux), and pcig-64.exe or pcig.l64 (for 64-bit Microsoft Windows or Linux) of the PCIG tool will be located in the following directory, depending on the operating system:

 

•(Microsoft Windows): installation utility\bmc_products\tools\pcig

•(Linux): installation utility/bmc_products/tools/pcig

 

Before you can load a custom Knowledge Module (KM) in the BMC ProactiveNet Performance Management environment and configure it through BMC ProactiveNet Central Monitoring Administration, you must build and package the KM.

 

The PCIG tool builds and packages custom KMs and creates Product Package Files (PPFs), which are required for the build and package (BAP) image. The PCIG tool is supported only in Linux and Windows platforms.

 

 

Creating a BAP image for custom KMs

 

You can create a BAP image for custom KMs by running the following command:

$. /pcig<32-bit or 64-bit> -p <product_name> -r <release> -s <source_path> -l <os_list> -t <title> -c

Where:

-p <product_name>—Name of the KM package in the format, [A-Za-z0-9]. It also specifies the output name of the PPF file that will be created. The maximum number of character allowed in the product name is 10.

-r <release>—The version of the package to be used with BMC ProactiveNet in the format, vv.mm.rr

-s <source_path>—The path required to package member files. The files under source_path are copied to dest_path/products/product_name and zipped, and their respective entries are added under the files section of the ppf. The ppf and cat file are located at dest_path/Products/product_name, and a copy of the PPF is also placed in dest_path/Index/.

-l <os_list>—(Optional.) Comma separated list of OS types. The supported values are: AIX, SOLARIS, HP, LINUX, WINDOWS, ALL, ALL-UNIX. If you have not specified any operating system type, by default, ALL is considered as the value.

-t <title>—(Optional.) Product name (within double quotes) to be used in the BMC ProactiveNet Central Monitoring Repository. If you have not specified the product name, by default the name of the KM package (value of the -p switch) is considered as the value.

-c—(Optional.) Print copyright details

Here is an example of creating a BAP image for a custom KM, XOM:

 

 

$. /pcig-64 -s XOM/ -p XOM -t "PATROL for XOM" -r 1.0.00

prearing PPF [HEADER] section...

Loading files for packaging...

7 files prepared for packaging.

Preparing PPF [FILES] section...

Generating PPF file... bmc_products/Index/XOMs.km.ppf...

Generating AT file... bmc_products/Products/XOMskm/XOMskm.cat...

Here a BAP image for XOM KM will be created with the name "PATROL for XOM",  and the version 1.0.00. After you run the above command, the bmc_products folder will be created in the parent directory (temporary folder).

$ls -ltr

total 84

-rwxr-xr-x 1 wasbld bmc 74358 Jan 8 19:20 pcig

drwxr-xr-x 4 wasbld bmc 2048  Jan 8 20:30   XOM

drwxr-xr-x 4 wasbld bmc 2048  Jan 8 20:40   bmc_products

The bmc_products folder contains files required for building and packaging the KM. To list the files created for building and packaging the KM, run the find bmc_products -type f command.

 

Example:

c$ find bmc_products -type f

bmc_products/Index/XOMs.ppf

bmc_products/products/XOMs.km/XOMs1.gz

bmc_products/products/XOMs.km/XOMs2.gz

bmc_products/products/XOMs.km/XOMs3.gz

bmc_products/products/XOMs.km/XOMs4.gz

bmc_products/products/XOMs.km/XOMs5.gz

bmc_products/products/XOMs.km/XOMs6.gz

bmc_products/products/XOMs.km/XOMs7.gz

bmc_products/products/XOMs.km/XOMskm.ppf

bmc_products/products/XOMs.km/XOMskm.cat

bmc_products/imageinfo.000000-000000

c$ find bmc_products -type f

bmc_products/Index/XOMs.ppf

bmc_products/products/XOMs.km/XOMs1.gz

bmc_products/products/XOMs.km/XOMs2.gz

bmc_products/products/XOMs.km/XOMs3.gz

bmc_products/products/XOMs.km/XOMs4.gz

bmc_products/products/XOMs.km/XOMs5.gz

bmc_products/products/XOMs.km/XOMs6.gz

bmc_products/products/XOMs.km/XOMs7.gz

bmc_products/products/XOMs.km/XOMskm.ppf

bmc_products/products/XOMs.km/XOMskm.cat

bmc_products/imageinfo.000000-000000

Run the following command to see the values created in the PPF file:

$ more bmc_products/Index/<KM file name>skm.ppf

Example:

$ more bmc_products/Index/XOMskm.ppf

[HEADER]

PRODUCT=XOMskm

PKGNAME=XOM-KM-Application_Classes

VERSION=1.0.00

VERSION_COMPATIBILITY=ALL

BOOK=PATROL Knowledge Modules

DESC=PATROL for XOM

RELEASEVER=3.4, 3.5, 7.1, 7.2, 7.4

OSLIST=all

PRODUCT_FAMILY=PATROL

INFRASTRUCT_DESIGNATOR=PAT, PAV, PAA, PWN

ISKM=1

PKG_SIZE=29321

PKG_LOCALE=

AUTOSELECT

SEQUENCE=10000

[END HEADER]

 

[FILES]

./lib/knowledge/XOM_Performance.km;Y;;;644;all||

./lib/knowledge/XOM_Performance.kml;Y;;;644;all||

./lib/knowledge/XOM_Perf_Disks.km;Y;;;644;all||

./lib/knowledge/XOM_Perf_Disk_CONTAINER.km;Y;;;644;all||

./lib/knowledge/XOM_Perf_MSSQL_Locks.km.km;Y;;;644;all||

./lib/knowledge/XOM_Perf_MSSQL_Locks_CONTAINER.km.km;Y;;;644;all||

./XOM/XOM.cfg;Y;;;755;all

 

The BAP image of the custom KM will be created in a zipped file, and you can import this into BMC Performance Management Repository.

 

If you have in your KM code any calls to pconfig function (either to get or to write any values), as the structure of the /ConfigData/<KM name> branch has changed with respect to pure PATROL environment (without BPPM/CMA), then you will need to edit the KM files accordingly.

 

Here’s an example:

 

In a custom KM there is a file named MS_WATCH.km.

Within that file I can see below line:

 

    preconf=trim(pconfig (\"GET\", \"/OracleConfig.\".sid.\".FilterExcl\"),\" \", 3);\

 

Usually in the pconfig call you needed to pass the function (GET in this case) and the config var (/OracleConfig.\".sid.\".FilterExcl) to get its value.

 

As pconfig vars in 9.5 coming from policy configuration are containing different structure: /ConfigData/<KM name> ... , if within your code you are accesing the config vars from the custom KM then you would need to edit your KM files to accomplish with this new structure.

 

The above example may not be a good example because it seems it is accessing a config var from Oracle KM and this may not change when converting to CMA, but for instance, if the variable you would have in your code was as below:

    preconf=trim(pconfig (\"GET\", \"/MyOwnKM.\".sid.\".FilterExcl\"),\" \", 3);\

 

Then you should probably need to edit it when converting it to CMA to be like below:

    preconf=trim(pconfig (\"GET\", \"/ConfigData/MyOwnKM.\".sid.\".FilterExcl\"),\" \", 3);\

 

The same should happen with any pconfig calls with REPLACE function.

 

Managing the repository

Through BMC ProactiveNet Central Monitoring Administration, you can import new and updated monitoring components to the Central Monitoring Repository. You can also delete components that are not used in installation packages.

You can do the following kinds of imports:

 

Import Type    Description

Full repository    The entire repository with the most up-to-date BMC PATROL components and monitoring solutions. The repository files are imported from the following compressed files. For details about the contents of each file, see  BMC ProactiveNet Central Monitoring Repository overview.

 

•    9.6_base-yyyymmdd-hhmmss.zip (where yyyymmdd-hhmmss is the date and time of the repository image), typically imported with BMC ProactiveNet Central Server installation.

•    9.6_extended-yyyymmdd-hhmmss.zip (where yyyymmdd-hhmmss is the date and time of the repository image), typically imported after installation, using the procedure described below.

 

Single solution    A single solution for a specific update or to replace a deleted file. The solution must be located on the local computer from which you are running the Central Monitoring Administration web-based console.

 

Custom solution    A solution that is customized for specific environments or requirements. The solution must be located on the local computer from which you are running the Central Monitoring Administration web-based console.

See Building a PATROL Knowledge Module Developers Guide for details.

 

Before you begin

If you want to import the entire repository, first download Central Monitoring Repository files from the BMC Electronic Product Distribution (EPD)  facility, or copy the files from your installation kit, to the BMC ProactiveNet Central Server file system.

 

To import the full repository

1.    In the navigation pane of Central Monitoring Administration, click the Repository drawer and select Manage Repository.

2.    Click Import.

3.    In the Import a New Solution dialog box, select Full repository and click Import.

4.    Select the repository file (9.x_base-yyyymmdd-hhmmss.zip or 9.x_extended-yyyymmdd-hhmmss.zip) from the BMC ProactiveNet Central Server file system, and click Extract.

The selected archive file is imported to the repository and extracted. You can close the window during the import process.

 

To import a single or custom solution

1.    In the navigation pane of Central Monitoring Administration, click the Repository drawer and select Manage Repository.

2.    Click Import.

3.    In the Import a New Solution dialog box, select Single solution or Custom solution.

4.    Browse to a source file in one of the following formats: zip, tar, or tar.gz.

The solution must be located on the local computer from which you are running the Central Monitoring Administration web-based console.

5.    (Custom solution, only)provide the following details:

 

•    Custom solutions name: The name of the custom solution, as it will be displayed in Central Monitoring Administration.

•    Custom solution version: The version number for the custom solution. Values in the first two version boxes are required.

6.    Click Import.

The selected archive file is imported to the repository and extracted. You can close the window during the import process.

 

In Central Monitoring Administration 9.0, some items might not appear in the Monitor Configuration screen even after importing both the BMC ProactiveNet 9.6 base and extended repositories. For more information, see Knowledge Base article KA408417 (Support logon ID required).

 

To delete components from the Central Monitoring Repository

1.    In the navigation pane of Central Monitoring Administration, click the Repository drawer and select Manage Repository.

2.    Select one or more of the components that are not used in an installation package.

The column Used within installation packages lists the number of installation packages that use the component.

3.    Click Delete and click Yes to confirm the deletion.

 

If you have any issues with customized KMs being imported into BPPM or managed through the CMA, please view the Webinar video and if problems persist, please contact BMC Support.

 

Newly Published Knowledge Articles - New Content has been added over the last month!

KA402252 - Is it possible to export CMA policies from one BPPM server to another?

KA417462 - Installation of BPPM 9.5 SP1 fails with following message in install log "Issue with finding server installation from ProductRegistry.xml file, trying with the windows registry"

KA417560 - Why an Integration Service Node (ISN) 9.5 is appearing as "Unknown:0" in BPPM CMA console?

KA417771 - Seeing MC_CELL_PROCESS_ERROR event with msg slot *** BUILTIN 450 *** recorded_arg/4 : The argument descriptor and recorded term have an incompatible structure.

KA417878 - A database rebuild is failing with "SQL error: User 'DBA' has the row in 'PARTITION_CNTL' locked"

Popular Knowledge Articles

KA352096 - Unable to delete PATROL Adapter from ProactiveNet Admin Console

KA345591 - dbsrv.exe process crashed with an assertion failure

KA346342 -On Windows 2008 BPPM server 'pw system status' shows mcell as !Not Running! even though the cell is running

KA349542 - How to monitor the connectivity status between Patrol Agent and Integration Service (Pproxy Service)? 

KA373446 - Steps to convert AWF adapter into Manual adapter

 

DON’T MISS A GREAT OPPORTUNITY: Upcoming Webinars

Check out the details here: BMC ProactiveNet Performance Management (BPPM) 9.5 Best Practices Webinar Series

Upcoming Webinar topics include:

•    High Availability & Disaster Recovery (November 2014)

 

Sign up now by accessing the link above. Then click on the topic of interest and sign up for the Webinar. These are 90 minute sessions designed to help you get the most of out the product.

 

 

Looking for a previous blog posting?

Find them here:  BMC TrueSight Support Blogs

 

Feedback1.jpg

 

Feedback Request:

Are these blogs helpful to you? We want to hear from you. Let us know what you think or what topics you would like presented in our blog.

Filter Blog

By date:
By tag: