opr-template Command-Line Interface

-rc_file <file> &| -username <login name> [ -password <password> | -smartcard | -winCrypto | -jks <keystore path> -jksPassword <keystore password> ] [[-port <port>] [-server <gatewayserver>] [-ssl] | [-u <URL>]]

opr-template <CONNECTION_INFO>{ -upload -input <directory or policy header file> [-mode <mode>] | -download -output <directory><object Specifier> | -check -input <directory or policy header file> | -list [<objectspecifier>] [-format xml] | -delete [<object Specifier>] [-format xml]}

<object Specifier> consists of: [-type <template|aspect>] {-id <versionID> | -name <name> [-object_version <version> | -all] }

You can download and upload policy templates individually or in chunks. The downloaded policies are located in the directory specified with the option -output, and their file names begin with their version ID. For the download and the upload, the CLI commands list the policies that were affected.

After downloading a policy template, a delta file in the format <versionID>_delta.xml is created. This file is used for internal purposes and controls when a policy is uploaded. With the delta file, OMi detects policy modifications. When the file is not there, OMi assumes that an upload must happen and creates a new version, even if the exact same policy is already in the database.

You can repeatedly edit the same policy files in the file system. Policy versioning is done as follows:

• opr-template checks if the version already exists in the database.
• If yes, OMi increases the highest existing version by 1 and uses it for the new policy version to be stored in the database.
• If no, OMi stores the new version in the database using the given number.

The upload auto-detects which policies were modified and ignores the rest. The upload also takes the policy IDs (version and container ID) into account, but the policy name and version are higher prioritized. HPE recommends to specify the policy name and version instead of the ID.

A policy templates consists of three parts. Each part is reflected as a separate file in the file system:

• <versionID>_header.xml: the policy header, containing general information like the policy template name, version, type, required instrumentation, categories, and the supported operating systems.
• <versionID>_data: the crucial part of a policy, containing log file patterns, SNMP trap match conditions, and monitoring thresholds.
• <versionID>_params.xml: the customizable list of parameters a policy exposes. If you regard a policy as a black box, the parameters are the screws to fine-tune it.

You can edit all three parts of a policy template. For a syntax description of the individual elements, see Review the policy syntax.

HPE recommends that you should first create a policy template in the UI, download it into the file system and then modify the policy. It is not recommended to write a policy from scratch in the file system.

The following work flow example shows the creation and editing process of a new policy named my OMi Bus Logfile, derived from the out-of-the-box policy OMi Bus Logfile.

1. Download the policy by running the following command:

   opr-template -download -name "OMi Bus Logfile" -output .

   Command output: "OMi Bus Logfile" 2.11 1aa582bf-379b-411e-a9a1-10bf41f2a648

2. Edit the policy template files.

   In the files ./1aa582bf-379b-411e-a9a1-10bf41f2a648_header.xml and ./1aa582bf-379b-411e-a9a1-10bf41f2a648_data, replace the string "OMi Bus Logfile" with "my OMi Bus Logfile".

3. Upload the policy.

   opr-template -upload -input .

   Command output:

   "my OMi Bus Logfile" 2.11 68a3eb63-28c6-472f-95e2-35b0e9155fb8
INFO: upload summary: total=1, ok=1, failed=0, skpped=0, ignoredStubs=0

4. Optional. Change the version.

   1. Assume you forgot to set the desired version number, for example 2.0. Again edit the header file ./1aa582bf-379b-411e-a9a1-10bf41f2a648_header.xml. Replace the string "2.11" with "2.0".

   2. Reupload the file: opr-template -upload -input .

      Command output:

      “my OMi Bus Logfile" 2.0 b093cabb-0cae-4014-b72a-957d765dd75b
INFO: upload summary: total=1, ok=1, failed=0, skpped=0, ignoredStubs=0

   3. As the version 2.11 is not needed, run the following command:

      opr-template -delete -name "my OMi Bus Logfile" –object_version 2.11

      Command output:

      Deleted "my OMi Bus Logfile" 2.11 68a3eb63-28c6-472f-95e2-35b0e9155fb8

The command option -check validates the policy syntax. The syntax check is also included in the -upload option.

The -check option behaves as follows:

• Searches for errors in all parts of a policy template (data, header, and parameter).

• Can check individual policy templates or can check all policies in a directory.

• If a policy contains multiple errors, only the first error is shown.

• Contacts the OMi backend per web service to do the validation.

• Behavior for mass uploads or bulk syntax checks: if one error is found, the opr-template CLI returns the code != 0.

For serious problems (like communication errors or certificate issues), the command returns immediately, whereas for recoverable errors (like policy syntax errors) the command continues and prints a summary line.