Searching the Help
To search for information in the Help, type a word or phrase in the Search box. When you enter a group of words, OR is inferred. You can use Boolean operators to refine your search.
Results returned are case insensitive. However, results ranking takes case into account and assigns higher scores to case matches. Therefore, a search for "cats" followed by a search for "Cats" would return the same number of Help topics, but the order in which the topics are listed would be different.
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 |
|
|
Either word in a topic |
|
|
Topics that do not contain a specific word or phrase |
|
|
Topics that contain one string and do not contain another | ^ (caret) |
cat ^ mouse
|
A combination of search types | ( ) parentheses |
|
- Command-Line Interfaces
- BBCTrustServer Command-Line Interface
- ConfigExchange Command-Line Interface
- ConfigExchangeSIS Command-Line Interface
- ConnectedServer Command-Line Interface
- ContentAutoUpload Command-Line Interface
- ContentManager Command–Line Interface
- ConfigWsTool Command-Line Interface
- opr-agt Command-Line Interface
- opr-archive-events Command-Line Tool
- Policy Management CLI workflows
- opr-assign Command-Line Interface
- opr-cert-mgmt Command-Line Interface
- opr-ci-list Command-Line Interface
- opr-close-events Command-Line Tool
- opr-config-tool Command-Line Interface
- opr-downtime Command-Line Interface
- opr-internal-tls-config Command-Line Interface
- opr-jobs Command-Line Interface
- opr-mp-installer Command-Line Interface
- opr-node Command-Line Interface
- opr-package-manager Command-Line Interface
- opr-script Command-Line Interface
- opr-sis-file-manager Command-Line Interface
- opr-template Command-Line Interface
- opr-tls-config Command-Line Interface
- opr-tool Command-Line Interface
- opr-user Command-Line Interface
opr-ci-list Command-Line Interface
The opr-ci-list command line utility enables you to retrieve the type, ID, and label for a set of CIs.
Location
<OMi_HOME>/opr/bin/opr-ci-list.[bat|sh]
Synopsis
opr-ci-list -help|-version|-examples|<CONNECTION_INFO><selector>
-rc_file <file> &| -username <login name> [ -password <password> | -smartcard | -winCrypto | -jks <keystore path> -jksPassword <keystore password> ] [[-port <port>] [-server <gatewayserver>] [-ssl] | [-u <URL>]]
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 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 Default: |
-server <GatewayServer>
|
Sets the target gateway server, using 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|-u} <url> |
Sets the target gateway server, using Default: |
Options
-ci_list <comma or blank separated CI IDs> | -node_list <comma or blank separated primary DNS names> | -ci_type <type> | -node_group <group> | -view_name <view> [-nodes_only] | -query_name <query> [-nodes_only] | -filter_name <node filter>
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. |
{-ci_type|-ct} <CI type name>
|
Retrieves all CIs of the specified CI type. |
{‑filter_name|‑fn} {<name of node filter>} |
Operation is executed on all CIs covered by the filter. |
{‑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. |
|
Specify a list of nodes on which the operation will be executed. |
|
Show only related node CIs (all subtypes). |
|
Operation is executed on all CIs covered by the query. |
|
Operation is executed on all CIs covered by the view. |
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
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 |
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-ci-list
commands.
-
List information for the CIs with the specified IDs:
opr-ci-list -username user -password passwd -ci_list ee05b4ecaa1f508b5047d2894d43a76d,5994f81063372abddd3c0114cc91a2b2
-
List information for nodes with the specified primary DNS name:
opr-ci-list -username user -password passwd -node_list test1.test.com, test2.test.com
-
List information for all CIs of the specified type (and subtypes):
opr-ci-list -username -password passwd -ci_type oracle
-
List information for all nodes that are members of the specified node group:
opr-ci-list -username user -password passwd -node_group testGroup -v
-
List information for all CIs contained in the specified view:
opr-ci-list -username user -password passwd -view_name myView -v
-
List information for all node CIs contained in the specified query:
opr-ci-list -username user -password passwd -query_name myQuery -nodes_only -v
-
List information for all node CIs that match the specified filter:
opr-ci-list -username user -password passwd -filter_name myFilter -v
We welcome your comments!
To open the configured email client on this computer, open an email window.
Otherwise, copy the information below to a web mail client, and send this email to ovdoc-asm@hpe.com.
Help Topic ID:
Product:
Topic Title:
Feedback: