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 > Automate operator functions and event change detection > RestWsUtil Command-Line Interface

RestWsUtil Command-Line Interface

The RestWsUtil command-line interface enables you to:

Carry out simple testing of the Event Web Service.
Perform the four basic operations: create, read, update and delete.

Create and update require an input file with the payload to send to the REST web service. Read and delete do not set the payload.

Location

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

Synopsis

RestWsUtil -help | -version | -verbose| <CONNECTION_INFO> | <operation>

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>

Option	Description
`{-c\|-create} <filename>`	Create the resource in the specified XML document. HTTP POST operation.
`-content_type <type>`	HTTP header content-type value to set for create and update operations. Default: `application/xml`
`{-d\|-delete}`	Delete the specified resource. The URL directly addresses the resource to delete. HTTP DELETE operation.
`{-h\|-help}`	Print this message and exit.
`{-o\|-output} <out_file>`	Name of output file for text returned from the web service request. Default: `stdout`
`{-r\|-read}`	Read the specified resource. HTTP GET operation.
`{-up\|-update} <filename>`	Update the resource with the specified XML document changes. HTTP PUT operation.
`{-v\|-verbose}`	Print verbose output.
`-version`	Print the version information and exit.

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

The utility uses basic authentication and has parameters to specify a username and password.

Note The appropriate identity assurance software, such as ActivIdentity, must be installed to be able to authenticate using a smart card when executing the RestWsUtil CLI.

When connecting to OMi servers using Remote Desktop Connections, the client system must also have the appropriate identity assurance software, such as ActivIdentity, installed to be able to authenticate using a smart card attached to the client system when executing the RestWsUtil CLI remotely.

In addition, in the Remote Desktop Connections dialog box, select More Show Options > Local Resources > More to open the Local devices and resources dialog box. Ensure that the Smart Cards check box is selected.

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

Some examples of usage of the RestWsUtil CLI follow.

Creating a Custom Attribute

Here is an example showing how to create a new custom attribute called MyNewCA for a specified event.

RestWsUtil -c newca.xml 
-url "http://<fully qualified domain name of OMi gateway server>/opr-web/rest/9.10/event_list/0695624b-93fa-40b1-8b0fc9b4ea07a4ec/custom_attribute_list"
-username admin -verbose 
Password: ******* 
INFO: Create the resource located at: newca.xml 
			
<?xml version="1.0"encoding="UTF-8"standalone="yes"?> 
<custom_attribute xmlns="http://www.hp.com/2009/software/opr/data_model"
   self="http://localhost:80/opr-web/rest/9.10/event_list/0695624b-93fa-40b1-8b0f-c9b4ea07a4ec/custom_attribute_list/MyNewCA"
   type="urn:xhp:2009:software:data_model:opr:type:event:custom_attribute"version="1.0"> 
  <name>MyNewCA</name>
  <value>100</value>
</custom_attribute>

INFO: Operation successful.

The new custom attribute and its value is written to stdout.

The contents of the newca.xml file look like this:

<custom_attribute xmlns="http://www.hp.com/2009/software/opr/data_model">
  <name>MyNewCA</name>
  <value>100</value>
</custom_attribute>

Send Help Center feedback