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

opr-config-tool Command-Line Interface

The opr-config-tool command-line interface enables you to list, update, and group templates, aspects, and management templates. You can add a template to an aspect, and display aspects and management templates that need to be updated before consuming a new template or aspect version.

Location

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

Synopsis

opr-config-tool {<operation> | -help | -version | -examples | -ping} <CONNECTION_INFO> [-verbose]

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 <operation>

opr-config-tool -list -type <objectTypes> | -get <objectSpecifier> | -delete <objectSpecifier> | -show_impacted <objectSpecifier> [-include_latest_update] | -latest_update <objectSpecifier> | -latest_update_preview <objectSpecifier> | -list_containment -type <objectTypes> <parentSpecifier> | -create_containment <objectSpecifier> <parentSpecifier> | -show_used_by <objectSpecifier> | -delete_containment <objectSpecifier> <parentSpecifier> <CONNECTION_INFO>

<objectTypes> consists of: {template|t} | {aspect|a} | {mgmt_template|mt} | {template_group|tg} | {ConfigFolder|cf}

<objectSpecifier> consist of: -type <objectTypes> {-id <objectID> | -name <objectName> [-object_version <objectVersion>]}

<parentSpecifier> consists of: -parent_type <parentTypes> {-parent_id <parentID> | -parent_name <parentName> [-parent_version <parent object version>]}

<parentTypes> consists of: {aspect|a} | {template_group|tg} | {ConfigFolder|cf}

Option	Description
`{-create_containment\|-cc}`	Add a new child to a parent group.
`{‑delete\|-d}`	Delete the template, aspect, management template, template group, or config folder with the specified ID or name.
`{‑delete_containment\|-dc}`	Remove a child from a parent group.
`{‑examples\|-ex}`	List opr-config-tool usage examples.
`{-format\|-f} {<xml\|x> \| <text\|tx>}`	Change the output of the command into text or XML. The default is text.
`{‑get\|-g}`	Retrieve the template, aspect, management template, template group, or config folder with the specified ID or name.
`-id <objectID>`	Specify the ID of the object defined by `-type`. The ID can be used instead of the `-name` option.
`{‑include_latest_update\|-ilu}`	Can be called in combination with `-show_impacted`. This creates new aspect or management template versions. It is identical to executing `-show_impacted` and then `-latest_update` on the returned aspects and management templates.
`{‑list\|‑l}`	List all existing templates, aspects, management templates, template groups, or config folders, depending on the specified type.
`{‑list_containment\|‑lc}`	List the names and policy template container IDs of all children of the parent group. The supported types are templates or template groups in template groups, and aspects or management templates in a config folder.
`{latest_update\|-lu}`	Create new aspect or management template versions by including the latest template versions in an aspect, and the latest aspect versions in a higher-level aspect or management template.
`{‑latest_update_preview\|‑lup}`	Generate a forecast of what would happen if the latest template versions were included in an aspect, and if the latest aspect versions were included in a higher-level aspect or a management template.
`{‑name\|‑n} <object name>`	Identify the object by the name (after having been specified by the type).
`{‑object_version\|‑ov} <object version>`	Specify the object version.
`{‑parent_id\|‑pid} <parent object ID>`	Specify the ID of the parent (template group, config folder, or aspect). The ID can be used instead of the `-parent_name` option.
`{‑ping`	Check if the web service is available.
`{‑parent_name\|‑pn} <parent object name>`	Specify the name of the parent (template group, config folder, or aspect). The name can be used instead of the `-parent_id` option.
`{‑parent_type\|‑pt} <parent type>`	Specify the parent type.
`{‑parent_version\|‑pv} <parent object version>`	Specify the parent object version.
`{‑show_impacted\|‑si`	After modifying a template or an aspect (and creating a new version by doing that), this shows which aspects and management templates should be updated to consume the new versions.
`{‑show_used_by\|‑sub`	Show which aspects consume the specified template version, and show which higher-level aspects or management templates consume the specified aspect version.
`{‑type\|‑t}`	Specify the object type. The options `-list`, `-get`, `-delete`, `-update`, `-list_containment`, `-create_containment`, and `-delete_containment` need a specific type.

Notes

The opr-config-tool CLI performs operations on both versioned and unversioned elements. Templates, aspects, and management templates are versioned, while template groups and config folders are unversioned. Versioned elements are displayed in the format <name> <version> <version ID>, and unversioned elements are displayed in the format <name> <id>.
Use opr-assign, opr-config-tool and opr-template together for an end-to-end CLI policy management workflow. For details, see Policy Management CLI workflows.
The generated output can be simple or nested. Simple output is defined as one single line. Nested output shows elements that belong together. For example, nested output could look like this:
```
mt “myMT1” 1.5 <id_MT1>
  aspect “myAspect1” 4.7 <id_aspect1>
    aspect “myAspect1_1”  1.0  <id_aspect1_1>
mt “myMT2” 3.4 <id_MT2>
  aspect “myAspect2” 1.2  <id_aspect2>
```
In this example, the management template myMT1 contains the aspect MyAspect1 which, in turn, contains the aspect MyAspect1_1.

For list operations (-list and -list_containment), the output is sorted by name.
If you specify only the object or parent name as input parameter of a versioned element, by default the latest version of the object is displayed.
If you want more details, you can use the option -format xml. The XML format prints the output from the OMi internal web services without any further processing.

Tip Linux or cygwin users who want to process quoted input within shell scripts, for example after running opr-config-tool -list -type mt, can use the following commands:

$ while read l; do echo $l | xargs proc.sh; done </tmp/quotedInput

With quotedInput containing lines similar to "OMi Server Self-Monitoring" 3.2 c40033c7-34c2-4764-a420-5bd2927a175a. proc.sh is a shell script that executes just one command for illustration purposes: echo " $1 xx $2 xx $3"

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

List all templates:

opr-config-tool -list -type template
Retrieve the myPolicy template for version 1.2:

opr-config-tool -get -type t -name myPolicy -object_version 1.2
Delete myPolicy:

opr-config-tool -list -delete -type t -name myPolicy
Show the aspects and management templates that do not consume the latest version of myPolicy:

opr-config-tool -show_impacted -type t -name myPolicy
Update myAspect to consume the latest template versions:

opr-config-tool -latest_update -type a -name myAspect
Preview which aspects and management templates would be generated when running latest_update for myMT:

opr-config-tool -latest_update_preview -type mt -name myMT
List all templates in a template group with the id templateGroupID:

opr-config-tool -list_containment -type template -parent_type template_group -parent_id templateGroupID
List all templates from myTemplateGroup:

opr-config-tool -list_containment -type template -parent_type template_group -parent_name myTemplateGroup
Add myPolicy to the template group with the ID templateGroupID:

opr-config-tool -create_containment -type template -name myPolicy -parent_type template_group -parent_id templateGroupID
Add myPolicy for version 1.2 to myAspect:

opr-config-tool -create_containment -type template -name myPolicy -object_version 1.2 -parent_type aspect -parent_name myAspect
Delete myPolicy to the template group with the ID templateGroupID:

opr-config-tool -delete_containment -type template -name myPolicy -parent_type template_group -parent_id templateGroupID
Delete myPolicy from myAspect:

opr-config-tool -delete_containment -type template -name myPolicy -parent_type aspect -parent_name myAspect

Send Help Center feedback