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-tool Command-Line Interface

opr-tool Command-Line Interface

You can use the opr-tool command-line interface (CLI) to interact with tools using the Tool Execution web service API.

The CLI enables you to use the web service API without having to set up a REST-based communication channel.

For information on the Tool Execution web service, see Tool Execution Web Service Interface.

Location

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

Synopsis

opr-tool -help|-verbose|-example|<CONNECTION_INFO>|<toolRelatedOptions>

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`

Options

Syntax for <toolRelatedOptions>

opr-tool <CONNECTION_INFO> -query {-event_list <event_ids> | -ci_list <ci_ids> | -node_list <nodenames>}

opr-tool <CONNECTION_INFO> -get_user_parameters <TOOL_SELECTOR>

opr-tool <CONNECTION_INFO> -run <TOOL_SELECTOR> { <CI_SELECTOR> | <EVENT_SELECTOR [<EVENT_CI_SPECIFIER>]> } [ <USER_PARAMETERS>]

<TOOL_SELECTOR> consists of: -id <tool_id> | -name <tool_name>

Note: CIs contained in <CI_SELECTOR> that do not fit the tool's CI type definition are ignored.

<USER_PARAMETERS> consists of: -parameters <key>=<value>[,<key>=<value>[,...]]

<EVENT_SELECTOR>consists of: -event_list <comma_separated_event_ids> [<EVENT_CI_SPECIFIER>]

<EVENT_CI_SPECIFIER> consists of: -event_related_ci | -event_node | -event_source_ci

Option	Description
`{-ci_list\|-cl} <comma-or blank-separated list of CI IDs>`	Specify a list of CIs (identified by ID) on which the operation will be executed.
`{-event_list\|-el} <comma-or blank-separated list of event IDs>`	Specify a list of events (identified by ID) on which the operation will be executed.
`{‑event_node\|‑en}`	Operation is executed on the node on which the CI is hosted, for example, the node on which a database instance is running.
`{‑event_related_ci\|‑erci}`	Operation is executed on the CI to which the event is related and from which you can reference CI attributes in the tool definition.
`{‑event_source_ci\|‑esci}`	Operation is executed on the node that created the event.
`{‑filter_name\|‑fn} {<name of node filter>}`	Operation is executed on all CIs covered by the filter.
`{‑get_user_parameters\|‑gup}`	List parameters to be filled out for the specified tool.
`{‑id}`	Specify the tool ID.
`{-name \|-n} [<name of the tool>]`	Specify the name of the tool.
`{‑node_group\|‑ng} <node group name>`	Operation is applied on all nodes in the specified node group. You can either specify a simple name for the node group, or in the case of hierarchical node groups, a relative or absolute path.
`{-node_list\|-nl} <comma- or blank-separated list of hostnames or hostname CI IDs>`	Specify a list of nodes on which the operation will be executed.
`{‑parameters\|‑p} <comma- or blank-separated list of <parameter name>=<parameter value> pairs for user parameters required by the tool>`	Specify tool parameter values.
`{‑query\|‑q}`	List all tools available for the specified events, CIs, or nodes.
`{‑query_name\|‑qn} <name of UCMDB TQL query>`	Operation is executed on all CIs covered by the query.
`‑run`	Run the specified tool on the specified targets.
`{‑view_name\|‑vn} <name of UCMDB view>`	Operation is executed on all CIs covered by the view.

Restrictions

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

This section shows a number of examples you can use as a starting point for developing your own opr-tool commands.

Return the list of applicable tools for a list of CIs:

opr-tool -username user -password passwd -query -ci_list ci1, ci2
Return the list of applicable tools for a list of events:

opr-tool -username user -password passwd -query -event_list event1, event2
Return the list of applicable tools for a list of nodes (specified by name):

opr-tool -username -password passwd -query -node_list node.example.com
Get the list of parameters to be filled out for the tool with the specified id:

opr-tool -username user -password passwd -get_user_parameters -id toolid
Get the list of parameters to be filled out for the tool with the specified name:

opr-tool -username user -password passwd -get_user_parameters -name toolname
Run a tool on a set of CIs:

opr-tool -username user -password passwd -run -id toolid -ci_list ci1, ci2
Run a tool on a set of nodes:

opr-tool -username user -password passwd -run -id toolid -node_list examplenode1, examplenode2
Run a tool with user parameters on a set of CIs:

opr-tool -username user -password passwd -run -id toolid -ci_list exampleci1, exampleci2 -parameters param1=value1, param2=value2
Run a tool with user parameters on all CIs from a view:

opr-tool -username user -password passwd -run -id toolid -view_name exampleViewName -parameters param1=value1, param2=value2
Run a tool with user parameters on the node on which the related CI of the event is hosted:

opr-tool -username user -password passwd -run -id toolid -event_list exampleEvent -event_node -parameters param1=value1, param2=value2

Send Help Center feedback