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

opr-script Command-Line Interface

You can use the opr-script command-line interface (CLI) to enable and disable Groovy scripts of the following types:

Custom action scripts
Event processing interface (EPI) scripts
External instruction retrieval scripts

Tip To check whether a script is active, see the Active check box in the details of the corresponding script. When you disable a script using the opr-script CLI, the Active check box is cleared.

Location

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

Synopsis

opr-script -help | -version | <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>

-enable|-disable -type <type> -id <id>

Option	Description
{`-enable`\|`-e`}	Enables a previously disabled Groovy script.
{`-disable`\|`-d`}	Disables a Groovy script.
`-type <type>`	Groovy script of the type: `CUSTOM_ACTION` `EPI` `EXTERNAL_INSTRUCTION`
`-id <id>`	ID of Groovy script. The ID of the script is displayed in the script's properties in the corresponding UI. For example, to get the ID of a custom action script, navigate to: Administration > Operations Console > Custom Actions Alternatively, click Custom Actions. Select the script in the Custom Action Scripts pane and click Edit Item. Copy the ID in the lower right corner of the General page.

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 user running the opr-script command-line interface must be an OMi user with permissions to create custom actions, EPI, or external instruction retrieval scripts.

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

Disable a custom action script:

opr-script -user myU -password myPwd -disable -type CUSTOM_ACTION -id cebc429e-ab51-ae70-b070-454a092cbdc6
Enable an EPI script:

opr-script -user myU -password myPwd -enable -type EPI -id 603bb351-b346-ac2e-f7e2-454e4fc1d1ec

Send Help Center feedback