Pattern management

The Pattern Management UI enables you to upload patterns to the appliance, activate or deactivate patterns on the appliance, and to delete patterns which are no longer required. You can also download a zip archive of all patterns that are on the appliance. The following terms are used in the Pattern Management UI:

  • Pattern: a sequence of commands written in the Pattern Language (TPL), which contain instructions that identify scanned entities which are then used to create the BMC Atrium Discovery data model.
  • Package: a text file written in TPL which contains one or more patterns, or a zip archive of TPL files which contain one or more patterns.
  • Module: the logical grouping to which patterns belong. For example, the following patterns are all in the VMWareVMmodule:
    • VMware
    • VMwareConsolidateFromSI
    • VMwareConsolidateFromVirtualHost

This is an example package name: VMWareVM.VMwareConsolidateFromSI

Activating a pattern means that it is loaded and from then will be used to identify software instances. You cannot activate a pattern with a lower version number than one that has previously been activated. Delete the pattern with the higher version number first. All patterns specify the TPL version number that they use. If a pattern uses TPL language features which are from a later TPL version than specified, you cannot activate that pattern.

This page describes the management of packages through the UI. Configuring and editing the actual packages and patterns is described in Pattern configuration and editing.

Viewing details of all installed packages

All currently installed patterns can be viewed from this page in read-only format. To access the Installed Knowledge Updates page; from the Discovery tab, select Pattern Management.

The Upload New Package and Pattern Template headings are controls which hide additional sections of the page. Click these to display sections which enable you to:

The following links are provided:

  • Download all Patterns (Zip): enables you to download a zip file of all patterns on the appliance.
  • View Configuration of all Patterns: links to the All Pattern Module Configurations page which lists all patterns with configurable items.

For each installed pattern, the following columns are displayed:

  • Name: the name of the package. This is the name specified when the package was uploaded.
  • Description: brief description of the package. This is the description entered when the package was uploaded.
  • State: whether the pattern is Active or Inactive. If a pattern is Active, it is in use and will create data in the BMC Atrium Discovery model when triggered. If a pattern is Inactive, it is not in use and will not run.
  • Pattern Modules: shows the number of modules contained in the package. If any pattern modules have been disabled, then this is shown in brackets after the total.

Uploading a TPL package to the appliance

A TPL package can be a zip archive of pattern files, or a single TPL file containing one or more patterns.

TKU packages contain multiple components, not simple a zip archive of TPL patterns. These should be uploaded and activated using the Knowledge Update page.

  1. To upload a package, click Upload New Package.
  2. Enter the pattern filename into the Upload New Package dialog box, or click Browse to locate a file. The Name field is automatically populated with the file name without the .tpl suffix. You can enter a description of the pattern into the Description field, this description is displayed in the UI.
  3. To upload the file to the appliance, click Upload.
  4. The pattern is uploaded to the appliance and is placed in the Inactive state. Before you can use the pattern you will need to Activate it.
Uploading and activating a TPL package

You can also upload and activate a package simultaneously. You may prefer to use this method when testing patterns. To do this, enter the package details as above and click Upload & Activate.
The window is refreshed and the newly uploaded package is shown as Active.

Using pattern templates

Pattern templates are supplied with BMC Atrium Discovery to provide a starting point from which to model Software Instances and applications.

  1. To view the pattern templates that are available, click Pattern Templates.
  2. In the Pattern Templates window is a table with each row corresponding to a template pattern. For each pattern the following information or link is displayed:
    Name: the name of the pattern. This is a link to the View Pattern template window. This is described in The View Pattern Template Window.
    Description: a read only description of the pattern.
    Options: a Download link. Clicking this enables you to download a copy of a particular pattern to your local filesystem.
    There is also a Download All Patterns (Zip) link which enables you to to download a zip archive of all of the template patterns.
Viewing pattern template window

The View Pattern Template Window shows a read only version of the pattern with syntax highlighting where TPL keywords and variables are displayed in different colors to the other text. The Turn Line Numbering On/Turn Line Numbering Off button toggles line numbering can be used to ease copying and pasting text from one of the templates. A button to close the window is also provided.

Managing packages on the appliance

You can activate, deactivate, and delete packages which are on the appliance.

Activating a TPL package

To activate a package:

  1. Select an Inactive package from the package list, using the selection checkbox on the left of the row containing the package. You can select multiple patterns, or by selecting the checkbox in the table heading, you can select all patterns.
  2. Click Activate.
    The window is refreshed to show an Items Marked for Action pane.
  3. You can validate the pattern to ensure that there are no problems with the pattern. To do this, click Validate All Listed Changes.
  4. If no problems are found with the pattern, the pane is refreshed with a The Requested Changes were Successfully Validated message.
  5. To complete the activation of the package, click Commit All Listed Changes.
Deactivating a TPL package

To deactivate a package:

  1. Select an Active package from the package list, using the selection checkbox on the left of the row containing the package. You can select multiple patterns, or by selecting the checkbox in the table heading, you can select all patterns.
  2. Click Deactivate.
  3. The window is refreshed to show an Items Marked for Action pane.
    You can validate the pattern to ensure that there are no problems with deactivating the pattern. To do this, click Validate All Listed Changes.
  4. If no problems are found, the pane is refreshed with a The Requested Changes were Successfully Validated message.
  5. To complete the deactivation of the package, click Commit All Listed Changes.
Deleting a TPL package

To delete a package:

  1. Select a package from the package list, using the selection checkbox on the left of the row containing the package. You can select multiple patterns, or by selecting the checkbox in the table heading, you can select all patterns.
    If you select an active pattern for deletion, it is deactivated and deleted when you commit the changes.
  2. Click Delete.
    You can validate the operation to ensure that there are no problems with the deletion. To do this, click Validate All Listed Changes.
  3. If no problems are found, the pane is refreshed with a The Requested Changes were Successfully Validated message.
  4. To complete the deletion of the package, click Commit All Listed Changes.
Downloading all TPL packages

To download all of the packages that are installed on the appliance, click Download All Patterns (Zip) above the package list. A Save As dialog box is displayed for you to enter a location to save the file.

Was this page helpful? Yes No Submitting... Thank you

Comments