Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
Search for | Example | Results |
---|---|---|
A single word | cat
|
Topics that contain the word "cat". You will also find its grammatical variations, such as "cats". |
A phrase. You can specify that the search results contain a specific phrase. |
"cat food" (quotation marks) |
Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase. |
Search for | Operator | Example |
---|---|---|
Two or more words in the same topic |
|
|
Either word in a topic |
|
|
Topics that do not contain a specific word or phrase |
|
|
Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
A combination of search types | ( ) parentheses |
|
- Command-Line Interfaces
- BBCTrustServer Command-Line Interface
- ConfigExchange Command-Line Interface
- ConfigExchangeSIS Command-Line Interface
- ConnectedServer Command-Line Interface
- ContentAutoUpload Command-Line Interface
- ContentManager Command–Line Interface
- ConfigWsTool Command-Line Interface
- opr-agt Command-Line Interface
- opr-archive-events Command-Line Tool
- Policy Management CLI workflows
- opr-assign Command-Line Interface
- opr-cert-mgmt Command-Line Interface
- opr-ci-list Command-Line Interface
- opr-close-events Command-Line Tool
- opr-config-tool Command-Line Interface
- opr-downtime Command-Line Interface
- opr-internal-tls-config Command-Line Interface
- opr-jobs Command-Line Interface
- opr-mp-installer Command-Line Interface
- opr-node Command-Line Interface
- opr-package-manager Command-Line Interface
- opr-script Command-Line Interface
- opr-sis-file-manager Command-Line Interface
- opr-template Command-Line Interface
- opr-tls-config Command-Line Interface
- opr-tool Command-Line Interface
- opr-user Command-Line Interface
opr-package-manager Command-Line Interface
You can use the opr-package-manager command-line interface (CLI) to manage and deploy HPE Software deployment packages in Monitoring Automation.
After uploading an HPE Operations Agent deployment package, you can update already existing HPE Operations Agent installations with later versions (full version or patch version) or with agent hotfixes of the same version. For more information, see Monitored Nodes.
You can also use the tool to list the deployment packages that are available in Monitoring Automation, to deploy packages, and to delete a deployment package from the server.
Learn More
A deployment package usually contains agents, programs, or instrumentation that is ready for updating installed agents on monitored nodes. A package can contain individual files as well as subpackages, which are collections of files. For example, the HPE Operations Agent deployment package (named Operations-agent
) contains a number of subpackages that make up the agent software: HPOvXpl
, HPOvSecCo
, HPOvEaAgt
, and many more.
A package is defined by a descriptor file. The descriptor file contains the following information:
-
Descriptive information about the package (for example, name, description, and version).
-
Name of the installer (for example,
oasetup.exe
). -
List of files and packages included in the package.
By default, opr-package-manager recursively uploads all packages with the package descriptor file OVO-Agent.xml
starting from the current working directory. For uploading deployment packages, you can optionally specify the name of the descriptor file and the directory from which the packages will be uploaded (for example, ‑upload_packages OVO-Agent.xml ‑input c:\Agent\packages\
). When deleting a package, opr-package-manager requires the package name (for example, Operations-agent
).
Location
<OMi_HOME>/opr/bin/opr-package-manager.[bat|sh]
You can run opr-package-manager on a gateway or a data processing server. The server processes must be running.
Synopsis
opr-package-manager [<CONNECTION_INFO>] {<toolInfo> | <operation> | <target>}
Options
-rc_file <file> &| -username <login name> [ -password <password> | -smartcard | -winCrypto | -jks <keystore path> -jksPassword <keystore password> ] [[-port <port>] [-server <gatewayserver>] [-ssl] | [-u <URL>]]
Note If <CONNECTION_INFO>
is omitted, the command is executed on the server to which you are logged on.
Option | Description |
---|---|
{-rc_file | -rcf }<file>
|
Location of your credential store. Values for your username, password, java keystore location, and java keystore password can be defined here, enabling you to run commands without having to specify the values individually each time. Use the options -list_rc , -set_rc , and -delete_rc to work with the file. The default file is <OMi_HOME>/.opr-cli-rc . If this option is not specified, then commands automatically check the default file location for credentials. You must specify this option if your credential store file is in a non-default location. If this file does not exist or does not contain the correct settings, you must manually specify the credentials using the other command options. |
{-list_rc| -lrc} [-rc_file <file>]
|
Display the content of the file from which credentials are read. The file contains fields for java keystore, keystore password, username and password, and is encrypted by a hardcoded key. |
{-set_rc | -src} <key>=<value> [-rc_file <file>]
|
Configure one setting in the file from which credentials are read. Specify the setting and the new value by using a key=value pair. For example, -set_rc password=<password string> . |
{-delete_rc | -drc} <setting> [-rc_file <file> }
|
Delete setting from file from which credentials are read. Possible settings are username, password, jks, and jksPassword. |
{-username|-user} <login name>
|
Sets the login name of the user required to execute CLI operations on the target gateway server. |
{-password|-pw} <password>
|
Sets the password for the specified user. If using SSH on Cygwin, either enter the password in free text or use other communication methods, for example Java keystore, Windows keystore, or smart card authentication. Default value: empty string |
{-smartcard|-sc}
|
Use certificate stored on smart card or security token for authentication. When OMi is configured to use CAC authentication, the CLI tools under For more information, see Using command-line tools when client certificate enforcement is used. |
{-winCrypto|-wc}
|
If OMi is configured for TLS mutual authentication, this option specifies to use the Windows certificate store for authentication. The certificate store must hold exactly one client certificate, which OMi will use to authenticate the user. This option is only available on Windows systems. For details, see Configure Client Certificate or Smart Card Authentication. |
{-jks|-j} <keystore path>
|
If OMi is configured for TLS mutual authentication, this option can be used to specify the Java keystore to be used for authentication. The keystore must hold exactly one client certificate, which OMi will use to authenticate the user. Note It is not necessary that the client certificate contains the flag "Smart Card Logon (1.3.6.1.4.1.311.20.2.2)" in the "Enhanced Key Usage" field. For details, see Configure Client Certificate or Smart Card Authentication. |
{-jksPassword|-jp} <keystore password>
|
Password for accessing the Java keystore. |
{-port|-p} <port>
|
Uses port Default: |
-server <GatewayServer>
|
Sets the target gateway server, using Default: FQDN of the OMi gateway server |
-ssl |
When this option is specified, the HTTPS protocol is used to connect to the target gateway server. If omitted, the HTTP protocol is used. Cannot be used in conjunction with the |
{-url|-u} <url> |
Sets the target gateway server, using Default: |
{‑examples | ‑help | ‑version}
Option | Description |
---|---|
{‑examples|-ex} |
Displays a number of examples of how to use the tool. |
{‑help|‑h} |
Displays a summary of the command options. |
‑version
|
Displays version information for the tool. |
{‑upload_packages [<descriptor_ file>] ‑input <package_directory> [‑platform <[HP-UX|SOL|AIX|LIN|WIN|ALL>]}
{‑list_packages [<package_name>] [-format|-f [xml|json]]}
{‑delete_package <package_name>}
{‑delete_package_version <package_name> <package_version>}
{-deploy_package <package_name> -deploy_mode [NEWEST|CURRENT|VERSION ‑package_ID <package_ID>|PACKAGE -package_ID <package_ID>]}
Option | Description |
---|---|
{‑delete_package|‑dp <package_name>}
|
Deletes the deployment package. The package is only deleted from the Monitoring Automation database, not from any monitored nodes. The package can no longer be deployed after it has been removed. |
{‑delete_package_version|‑dpv <package_name> <package_version>}
|
Deletes the deployment package with the specified version. The package is only deleted from the Monitoring Automation database, not from any monitored nodes. The package can no longer be deployed after it has been removed. |
‑list_packages [<package_name>] [-format|-f [xml|json]]
|
Lists details of all deployment packages that exist in the Monitoring Automation database. To list details of a specific package, specify the package name. The output can be in XML or JSON format. The default is XML. To view the output more easily, redirect it to a file and then view the XML content in any of the major browsers. |
{‑upload_packages|‑up [<descriptor_ file>] ‑input|‑i <package_directory> [‑platform|‑plt <[HP-UX|SOL|AIX|LIN|WIN|ALL>]}
|
Uploads the deployment package specified by the descriptor file. If you do not specify a package, opr-package-manager uploads the default package The The |
{‑deploy_package|‑deplp <package_name> ‑deploy_mode|‑deplm [NEWEST|CURRENT|VERSION ‑package_ID|‑pkgid <package_ID>|PACKAGE ‑package_ID|‑pkgid <package_ID>]}
|
Deploys the deployment package with the specified name. The
The Tip Use the |
-query_name <query_name> | -view_name <view_name> | -node_list <node_list> | -all
Option | Description |
---|---|
{‑query_name|‑qn} <query_name>
|
Resets all deployment job states to |
{‑view_name|‑vn} <view_name>
|
Resets all deployment jobs states to PENDING for all nodes returned through the view. |
{‑node_list|‑nl} <node_list>
|
Resets all deployment jobs states to Separate multiple nodes with commas (for example, |
-all
|
Resets deployment jobs states to PENDING for all suspended or failed jobs. |
Exit Status
Exit Status |
Description |
Output |
---|---|---|
0
|
Successful completion of the requested operation |
No output. |
1
|
Failure of the requested operation |
An error message stating why the operation failed, followed by the tool's help text. |
300‑399
|
HTTP Redirection (300-399) |
An error message stating the HTTP error number and description. For more information about HTTP error status values, see publicly available HTTP documentation. |
400‑499
|
HTTP Client Error (400-499) |
|
500‑599
|
HTTP Internal Server Error (500-599) |
Restrictions
-
Authentication. Some operations require authentication. If
<authentication>
is required,<authentication>
must be specified and valid.If
<authentication>
is omitted when requesting an operation requiring authentication, opr-package-manager does not execute the requested operation, and exits with the following error:Username may not be null. Operation requires authentication. Please enter the login name and password.
The error can be fixed by inserting an
<authentication>
. -
Permissions. The user running the opr-package-manager command-line interface must be an OMi user with Monitored Nodes access rights. For more information, see Monitored Nodes and Users, Groups, and Roles.
Non-admin users also need the following file permissions to operate this command-line tool:
File Windows Permissions Linux Permissions <OMi_HOME>/conf/TopazInfra.ini
read r <OMi_HOME>/log/opr-clis.log
full control rw <OMi_HOME>/log/opr-pgctl.log
Note: This file is not available on gateway server systems.full control rw <OMi_HOME>/conf/encryption.properties
read r <OMi_HOME>/conf/seed.properties
read r -
Prerequisites. To run opr-package-manager successfully, the server processes must be running.
Examples
This section shows a number of examples you can use as a starting point for developing your own opr-package-manager commands.
-
List all available deployment packages:
opr-package-manager ‑username myU ‑password myPwd ‑list_packages > allpkg.xml
-
Recursively upload the HPE Operations Agent deployment packages for all platforms (starting from the current working directory):
opr-package-manager ‑username myU ‑password myPwd ‑upload_packages
-
Upload the HPE Operations Agent deployment packages for Windows monitored nodes from the file system:
opr-package-manager ‑username myU ‑password myPwd ‑upload_packages c:\Agent\OVO-Agent.xml ‑input c:\Agent\packages\ ‑platform WIN
-
Deploy the HPE Operations Agent deployment package version 11.14.005 to the nodes node1.example.com and node2.example.com:
opr-package-manager ‑username myU ‑password myPwd ‑deploy_package Operations-agent ‑deploy_mode VERSION ‑package_ID 11.14.005 ‑node_list "node1.example.com,node2.example.com"
-
Deploy the latest hotfix for the HPE Operations Agent to all nodes selected by the TQL query All_CIs_with_OM_Agents_Unix:
opr-package-manager ‑username myU ‑password myPwd ‑deploy_package Operations-agent ‑deploy_mode CURRENT ‑query_name All_CIs_with_OM_Agents_Unix
-
Delete the HPE Operations Agent deployment package from the database:
opr-package-manager ‑username myU ‑password myPwd ‑delete_package Operations-agent
-
Delete the HPE Operations Agent deployment package version 11.14.005 from the database:
opr-package-manager ‑username myU ‑password myPwd ‑delete_package_version Operations-agent 11.14.005
Troubleshooting
opr-package-manager logs information to the following log file:
<OMi_HOME>/log/opr-clis.log
We welcome your comments!
To open the configured email client on this computer, open an email window.
Otherwise, copy the information below to a web mail client, and send this email to ovdoc-asm@hpe.com.
Help Topic ID:
Product:
Topic Title:
Feedback: