Nimsoft Monitor packageeditor...

packageeditor Guide v4.0 series

Nimsoft® Monitor™

Legal Notices Copyright © 2012, CA. All rights reserved.

Warranty

The material contained in this document is provided "as is," and is subject to being changed, without notice, in future editions. Further, to the maximum extent permitted by applicable law, Nimsoft LLC disclaims all warranties, either express or implied, with regard to this manual and any information contained herein, including but not limited to the implied warranties of merchantability and fitness for a particular purpose. Nimsoft LLC shall not be liable for errors or for incidental or consequential damages in connection with the furnishing, use, or performance of this document or of any information contained herein. Should Nimsoft LLC and the user have a separate written agreement with warranty terms covering the material in this document that conflict with these terms, the warranty terms in the separate agreement shall control.

Technology Licenses

The hardware and/or software described in this document are furnished under a license and may be used or copied only in accordance with the terms of such license.

No part of this manual may be reproduced in any form or by any means (including electronic storage and retrieval or translation into a foreign language) without prior agreement and written consent from Nimsoft LLC as governed by United States and international copyright laws.

Restricted Rights Legend

If software is for use in the performance of a U.S. Government prime contract or subcontract, Software is delivered and licensed as "Commercial computer software" as defined in DFAR 252.227-7014 (June 1995), or as a "commercial item" as defined in FAR 2.101(a) or as "Restricted computer software" as defined in FAR 52.227-19 (June 1987) or any equivalent agency regulation or contract clause. Use, duplication or disclosure of Software is subject to Nimsoft LLC’s standard commercial license terms, and non-DOD Departments and Agencies of the U.S. Government will receive no greater than Restricted Rights as defined in FAR 52.227-19(c)(1-2) (June 1987). U.S. Government users will receive no greater than Limited Rights as defined in FAR 52.227-14 (June 1987) or DFAR 252.227-7015 (b)(2) (November 1995), as applicable in any technical data.

Trademarks

Nimsoft is a trademark of CA.

Adobe®, Acrobat®, Acrobat Reader®, and Acrobat Exchange® are registered trademarks of Adobe Systems Incorporated.

Intel® and Pentium® are U.S. registered trademarks of Intel Corporation.

Java(TM) is a U.S. trademark of Sun Microsystems, Inc.

Microsoft® and Windows® are U.S. registered trademarks of Microsoft Corporation.

Netscape(TM) is a U.S. trademark of Netscape Communications Corporation.

Oracle® is a U.S. registered trademark of Oracle Corporation, Redwood City, California.

UNIX® is a registered trademark of the Open Group.

ITIL® is a Registered Trade Mark of the Office of Government Commerce in the United Kingdom and other countries.

All other trademarks, trade names, service marks and logos referenced herein belong to their respective companies.

Contact Nimsoft

For your convenience, Nimsoft provides a single site where you can access information about Nimsoft products.

At http://support.nimsoft.com/, you can access the following:

■ Online and telephone contact information for technical assistance and customer services

■ Information about user communities and forums

■ Product and documentation downloads

■ Nimsoft Support policies and guidelines

■ Other helpful resources appropriate for your product

Provide Feedback

If you have comments or questions about Nimsoft product documentation, you can send a message to [email protected].

http://support.nimsoft.com/

mailto:[email protected]

Contents 5

Contents

Chapter 1: packageEditor

The Package editor creates and modifies packages used for distribution to Robots. Selecting your local Archive node in Infrastructure Manager, all packages will be listed in the main window pane.

Right-clicking in the list of packages, selecting New opens the Package Editor dialog, enabling you to create new Probe packages. Probe packages are used for Probe distribution to Robots. The new probe package will be placed in your local package archive.

The package editor enables the user to change the contents of a package. A package contains some general properties and a set of sections. Each section contains a set of files and/or probe definitions.

packageEditor General properties

When creating a new package, please specify these properties first, as some of these values will be used when adding files and probe definitions.

Field Description

Name The package name. Note that the name must be unique in the Nimsoft Archive where the package is stored.

Description A general description of the package.

Copyright A copyright statement for the author of the package.

Group The group to which the package will belong. You can use any group name you want, but some default groups are suggested:

Application

Gateway

Network

System

Author Indicates who created the package.

Date The creation date of the package. You can modify this property as you like.

Version The package version should be specified as two dot-separated numbers.

6 packageeditor Guide

Build A number that is automatically incremented when the package is modified with the Package Editor.

No direct install Set this flag if it does not make sense to distribute the package.

License required This flag indicates that a license is required to be able to distribute the package. Beware that once this option is turned on and the package saved, it cannot be turned off again.

packageEditor Sections

There are three section types:

■ Normal section intended for distribution to a specified operating system or operating system type.

■ GUI section intended to contain a configurator for a specific probe.

■ Configuration of an existing probe.

When creating a new package, no sections will exist. You must right-click on the tab area and select 'Add section'.

Right-clicking a sec tion tab also lets you delete or rename the section.

On the package editor version made available with Nimsoft Server 3.60, a new right-click option lets you move a section leftwards.

On section creation, you must specify whether this is a configuration section or not. The configuration section contains only a subset of the properties other sections include.

Section properties

Field Description

OStype Determines which computer types the section is intended for. Value are

■ windows Intended for all windows platforms. If you want to be more specific, use the OS property below.

■ unix Intended for all unix platforms. Use the OS property below to specify specific operating systems.

■ GUI Not intended for distribution. This section will contain windows binaries used for configuring a probe. The files in this section are fetched by Infrastructure Manager when needed.

Chapter 1: packageEditor 7

Field Description

OS Determines the operating system this section is intended for.

Currently available are:

AIX_5 AIX_5_64 HPUX_11 HPUX_11_64

HPUX_11_ia64 LINUX_23 LINUX_23_64

LINUX_23_ppc64

SOLARIS_10_amd64

SOLARIS_10_i386

SOLARIS_8_sparc

SOLARIS_8_sparcv9

TRU64

win32

win64

win64_ia64

Note that also regular expression matching is allowed, which will be matched against the OS Minor of the Robot as displayed in Infrastructure Manager.

Leaving this field empty indicates that it will match any operating system of the selected OStype.

Note that in most cases a 32-bit version will also be accepted for installation on the corresponding 64-bit Operating System. Use grouping and section order to ensure that the correct binary is installed (see also information about grouping below).


Field Description

Files The files contained in this section. Each file has the following properties:

■ Name The file name cannot be modified on distribution, so in the case you want the file to have different name you must first make a local copy with the new name.

■ Type File types supported are

■ ascii A text file. Please note that CR/LF conversion will take place on some platforms.

■ binary Any file that should be transferred with out any modification.

■ config A configuration file. If the file has the extension '.cfx', the contents will be merged to a '.cfg' file according to the rules described in the 'The Configuration file' section below.

■ register A library file that will be registered on distribution.

■ script A script file.

■ Mode Determines the file access after distribution. Used on unix platforms.

■ Path The path to the file after distribution. The path may be relative to where the Robot is installed or absolute.

■ Check CRC When this flag is set, the checksum of the file is used on probe start up to verify that no modifications have been done. Set this option on files in which you expect no changes only.

Right-clicking in the files list of files offers you the following options:

■ Add new files (note that you by also may add files by dragging them from Windows Explorer).

■ Check the properties of the files.

■ Remove files

■ View the contents of the files (read only).

■ Edit the files.

■ Save a copy of the files on a location of your choice.

You are also allowed to rename files by selecting a file (left-click) and then type the new file name.


Field Description

Probe definitions The section may contain several probe definitions. A probe definition contains the following properties:

■ Name The probe name should be unique, as the Robot is not able to support several probes with the same name.

■ Description Your description of the probe.

■ Group The probe group. The same group as the package group is recommended.

■ Type The run-type of the probe:

■ daemon The probe should run the whole time. This type is used for probes that supply a command set and registers with the controller. You can use the timespec property below to specify time ranges in which the probe should run if required.

■ on_demand The probe is not automatically started, but can be started explicitly when required.

■ timed The probe should be started at time intervals or at specific points in time. You must use the timespec argument below.

■ The '<<' button can make it easier to fill out this field and the timespec field.

■ Timespec For a daemon probe, the time ranges in which the probe should run can be specified as follows:

■ from <timepoint> to <timepoint> [ , from <timepoint> to <timepoint> ]*

■ where timepoint is specified as

■ <minute> <hour>:<minute> <weekday> <hour>:<minute> <day> <hour>:<minute> <day> <month> <hour>:<minute>

■ where:

■ minute is a number in the range 0 to 59.

■ hour is a umber in the range 0 to 23.

■ weekday is one of mon, tue, wed, thu, fri, sat, sun.

■ day is a number in the range 1 to 31.

■ month is on of jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec.

■ For a timed probe the time specification is a combination of the range described above and one of the following

■ interval <number> <unit>

■ at <timepoint> [, at <timepoint> ]*

■ where unit is one of sec, min, hour, day, week, month

■ Workdir


Field Description

Environment variables Environment variables set here are added to the environment of the Robot, and therefore available to all the probes.

Dependencies Use this setting to create a dependency to a specific Robot version, necessary libraries or to other packages.

Miscellaneous You may set an additional command to be executed before or after distribution.

The Section Group field lets you set a group-ID for sections in the same group (for example win64 and win32).

When a section contains a group ID, it will only be installed if no other section with the same Group ID is already installed. Note that you need to make sure the order of the sections is correct.


configuration file (.cfx)

The configuration files in the package have the same configuration file format as installed configuration files except for added formatting commands. These formatting commands determine the way the distributed files are merged with existing ones.

The layout of a configuration files looks like this:

<section1>

key1 = value1

<section2>

key2 = value2

</section2>

</section1>

<section3>

key3 = value3

</section3>

Directives to determine merging behaviour are added to the beginning of a section. The following directives are supported:

‘‘

No directive: add keys from this section if they are not already present in the target configuration file.

‘overwrite’

Add keys from this section overwriting existing keys in the target configuration file. Note that changed sections are moved to the end of the containing section. This behaviour is needed when adding or changing a set of sections which need to be in a particular order.

‘edit’

Add or change keys from this section overwriting existing keys. The section position is not changed when using this option.

‘delete’

Remove keys mentioned.

‘clear’

Remove the whole section. If the section contains any keys then re-create the section adding these keys.

Note that the same section may appear several times, for example:

Action: delete


key1 =

</a>

Action:

key2 = hei

</a>

This removes key1 from section a and adds key2.

Directives are not inherited by sub-sections but must be specified explicitly for each. The ‘clear’ directive is an exception to this since it will affect all subsections.

Examples of configuration file use

Add a key if it does not already exist:

<setup>

loglevel = 0

</setup>

Set a key regardless of its earlier setting:

<setup> overwrite

loglevel = 0

</setup>

Remove a section:

<setup> clear

</setup>

Remove all keys from a section and add one:

<setup> clear

loglevel = 0

</setup>

Remove one key from a section and add another:

<setup> delete

logfile =

</setup>

<setup> overwrite

datafile = config.dat

</setup>


packageEditor General properties ............................................................................................................................... 5

packageEditor Sections ................................................................................................................................................ 6

Section properties ................................................................................................................................................. 6

configuration file (.cfx) ............................................................................................................................................... 11

Examples of configuration file use ...................................................................................................................... 12

Nimsoft Monitor packageeditor...

Documents

Transcript of Nimsoft Monitor packageeditor...