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	`AND` `and` `+` (plus symbol) `&` (ampersand)	`cat AND dog` `"cat food"+milk` `"cat food"&"dog food"`
Either word in a topic	`OR` `or` `\|` (pipe)	`cat OR dog` `cat \| dog`
Topics that do not contain a specific word or phrase	`NOT` `not` `!` (exclamation point)	`NOT cat` `! dog`
Topics that contain one string and do not contain another	`^` (caret)	`cat ^ mouse`
A combination of search types	`( )` parentheses	`cat + (dog \| mouse)` `cat \| dog + (! mouse)`

Operations Manager i10.62

Develop > Command-Line Interfaces > opr-jobs Command-Line Interface

opr-jobs Command-Line Interface

You can use the opr-jobs command-line interface (CLI) to restart or list suspended and/or failed deployment jobs. Combined with the Create suspended deployment jobs infrastructure setting, it is recommended to be used for automating the execution of deployment jobs during maintenance time periods.

The opr-jobs CLI activates suspended and restarts the failed deployment jobs by setting their state to PENDING. The job scheduler then adds these deployment jobs to the job queue and deploys them in series.

Location

<OMi_HOME>/opr/bin/opr-jobs.[bat|sh]

Synopsis

opr-jobs -help | -version | -examples | <Connection_INFO> <operation> <targets>

Options

Syntax for <CONNECTION_INFO>

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 `<OMi_HOME>/opr/bin/` do not directly prompt users to enter the password for the smartcard connected to the system. Instead, users must specify that a smartcard authentication is to be run, using the option `-sc` or `-smartcard`. Users attempting to run a tool without the `-smartcard` option automatically receive an error message. 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 `<port>` to connect to the target gateway server. Default: `80` (HTTP) `443` (HTTPS)
`-server <GatewayServer>`	Sets the target gateway server, using `<GatewayServer>` as the hostname or IP address to locate it. 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` option.
`{-url\|-u} <url>`	Sets the target gateway server, using `<url>` as the URL to locate it. Default: `https://<OMi gateway FQDN>:80/opr‑config‑server`

Syntax for <operation>

-start [suspended | failed] | -list [suspended | failed]

Option	Description
`-start [suspended \| failed]`	Resets the deployment job state to `PENDING` so that deployment jobs can be processed by the job scheduler.
`{-list\|-l} [suspended \| failed]`	Displays a list of suspended and failed deployment jobs.

Syntax for <targets>

Option	Description
`{‑query_name\|‑qn} <query_name>`	Resets all deployment job states to `PENDING` for all nodes returned through the query.
`{‑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 `PENDING` for all nodes that are listed. Separate multiple nodes with commas (for example, `node1.example.com,node2.example.com`).
`{‑node_group\|‑ng} <node_group>`	Resets all deployment jobs states to `PENDING` for a group of monitored nodes. A node groups is a CI collection containing hosts. Node groups can be maintained in the Monitoring Automation Node Editor or they can be imported through topology synchronization from OM to OMi. The nodes must exist in the RTSM and be associated with a CI of the type `om_operations_agent`. Specify node groups by their names or their paths (the latter applies to hierarchical node groups imported from OM for Windows).
`{‑filter_name\|‑fn} <filter_name>`	Performs the operation on a list of monitored nodes with the HPE Operations Agent installed that was obtained by applying the node filter.
`-all`	Resets deployment jobs states to `PENDING` for all suspended or failed jobs.

Restrictions

The user running the opr-jobs command-line interface must be an OMi user with the Redeploy All right and full control permission on the Deployment Jobs interface. For more information, see Deployment Jobs 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

Examples

Restart all possible deployment jobs:

opr-jobs -user myU -password myPwd -start
Restart all failed deployment jobs for Windows nodes:

opr-jobs -user myU -password myPwd -start failed -query_name All_jobs_for_Windows_nodes
Restart all deployment jobs on node1.example.com and node2.example.com:

opr-jobs -user myU -password myPwd -start -node_list node1.example.com,node2.example.com
Restart all suspended deployment jobs on the node group myNodeGrp, which is a member of the top-level group myTopNodeGrp:

opr-jobs -user myU -password myPwd -start suspended -node_group /myTopNodeGrp/myNodeGrp

Note that you can specify the path for hierarchical node groups only (the node groups imported from OM for Windows). The node groups imported from OM for UNIX using topology synchronization packages are always flat and are therefore specified by providing their names, for example:

opr-jobs -user myU -password myPwd -start suspended -node_group myNodeGrp

Send Help Center feedback