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
ConnectedServer Command-Line Interface
This section describes the options and parameters available in the ConnectedServer command-line interface.
Note The appropriate identity assurance software (for example, ActivIdentity) must be installed to be able to authenticate using a smart card when executing the ConnectedServer command-line interface.
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 ConnectedServer command-line interface 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 checkbox is selected.
Location
<OMi_HOME>/opr/bin/ConnectedServer
ConnectedServer <<CONNECTION_INFO>> <<ACTION>>
Where:
<<CONNECTION_INFO>>: -username <log-in name> -password <password>
[[-port <port>][-server <server>]
[-ssl] | [-url <url>]]
<<ACTION>>: -add <<OPTIONS>> | -delete <identifier> | -list |
-show <identifier> |
-update <identifier> <<OPTIONS>>
The valid arguments for <<OPTIONS>>
are:
-label <label> -name <name> -dns <DNS name> -active <yes|no>
-type <server> [-desc <description>]
[-dm <serial | serial_per_source | parallel[count]>] [-fwdtopo <yes|no>]
([-integrationuser <user>] [-integrationpw <pw>] [-integrationport <port>] [-issl <yes|no>] [-certificatefile <file> |-certificate] [-other_server <id>])
([-omiuser <OMi user>] [-omipassword <password>])
([-proxydns <dns name>] [-proxyuser <user>] [-proxypw <password>] [-proxyport <port>])
(((-scriptfile <name> [-scripttype <type>][-scriptcp <classpath>]) | -script_id <id>) |(-wsrooturl <url> [-bt <yes|no>]))
[-maxtimeout <max_time>]
([-drilldns <dnsname> -drillport <port> [-drillssl <yes|no>])
(([-toc no] ([-backsync no] | [-backsync yes -backsyncpw <pw>]) | ([-toc yes -backsyncpw <pw>]))
([-operating_system <irix|hp_ux|linux|solaris|sunos|windows>] [-sv <server version>])
[-defaultroutingdomain <routing domain>]
[-resynctimeinterval <days>]
[-defaultserver]
[-help | -version]
Note
-
<<CONNECTION_INFO>>
is required for all commands except for the options-help
and-version
. -
The command-line interface does not offer any options to configure health checking. For more information, see Configure health checks.
Options
Option |
Description |
---|---|
-a,-add |
Adds a new server. Any unspecified optional options are set to their default values. |
-active <yes|no> |
Enables or disables the server. Default value is |
-bs,-backsync <yes|no> |
Enables or disables backsync for the External Processing server. The default is |
-bspw,-backsyncpw <pw> |
Sets the backsync password. |
-certificate |
Certificate of the OM system will be saved. |
-certificatefile <file> |
Loads the certificate from the specified file. |
-d,-delete <identifier> |
Deletes the server specified by the ID or the name of the server. |
-ddns,-drilldns <dns name> |
Sets the DNS name of event drilldown system. |
-desc <description> |
Description of the server. |
-dm,-delivery_mode <serial|serial_per_ source|parallel[Count]> |
Sets the event forwarding Advanced Delivery Options It is possible to customize the way events and change notifications are delivered to this server. The available options are:
|
-dns <dns name> |
Sets the DNS name of the connected server being specified. |
-dport,-drillport <port> |
Sets the port of event drilldown system. |
-drd,-defaultroutingdomain <routing domain> |
SiteScope connected server only. The default routing domain from which the SiteScope topology data is collected. The routing domain is a continuous region of an IP network within which routing is possible without any intervening Network Address Translation (NAT) devices. The RTSM uses the routing domain to determine the reconciliation rules and workflows that are applied to a network range. Default value is: |
-ds,-defaultserver |
Sets the SiteScope server as a default server. Mandatory when the first SiteScope server is created. If a SiteScope server already exists and this option is used when creating a new SiteScope server, the default server is changed to the new server. |
-dssl,-drillssl <yes|no> |
Enables or disables HTTPS for event drilldown. Default value is: |
-ft,-fwdtopo <yes|no> |
Enables or disables forward topology. Default value is: |
-h,-help |
Displays a summary of the command options and exits. |
-iport,-integrationport <port> |
Sets the integration port. Default values for the supported server types are:
|
-ipw,-integrationpw <pw> |
Sets the integration user password. Note When updating a server that already has the integration user password set, you must enter If you created a server and set the integration user password and want to update the label of the server, enter the command:
|
-issl <yes|no> |
Enables or disables HTTPS for integration. Default value is: |
-iuser, -integrationuser <user> |
Sets the integration user. |
-j, -jks <arg> |
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. |
-jp, -jksPassword <arg> |
Password for accessing the Java keystore. |
-l,-list |
Lists the key properties of all configured connected servers. |
-label <label> |
Sets the label of the server. |
-mto, -maxtimeout <max timeout> |
Sets the maximum timeout. Default value is: |
-name <name> |
Sets the name of the server. |
-opw, -omipassword <password> |
Sets the password for the specified OMi user. |
-os, -operating_system <irix|hp_ux|linux|solaris|sunos|windows> |
Sets the operating system information for ArcSight and SiteScope server types. |
-osrv, -other_server <id> |
Sets an alternative server to execute action, tools, and instructions. |
-ouser, -omiuser <OMi user> |
In the SiteScope integration, the user name of the OMi administrator user that SiteScope should use when contacting OMi. |
-p, -port <port> |
Sets the port of the OMi server. Default value is: |
-pdns, -proxydns <dns name> |
Sets the proxy DNS name. Required if SiteScope uses a proxy for communication with OMi. |
-pport, -proxyport <port> |
Sets the port number for the proxy. |
-ppw, -proxypw <password> |
Sets the password associated with the proxy user. |
-puser, -proxyuser <user> |
Sets the user name for the proxy. |
-pw, -password <pw> |
Sets the password of the specified user. |
-rti, -resynctimeinterval <days> |
Sets the number of days for SiteScope to synchronize topology data with OMi. Default value is: |
-s, -show <identifier> |
Shows the properties of the server specified by the ID or the name of the server. |
-sc, -smartcard |
Use certificate stored on smart card or security token for authentication. When OMi is configured to use CAC authentication, the CLI tools under |
-scp, -scriptcp <classpath> |
Sets the script class path. Default is empty. |
-server <server> |
Sets the hostname or IP address of the OMi server. |
-sv, server_version <serverversion> |
Sets the operating system version information for ArcSight and SiteScope server types. |
-sfile, -scriptfile <file> |
Specifies a script file. |
-sid, -script_id <id> |
Specifies a script identifier. |
-ssl |
Specifies the networking protocol (HTTP or HTTPS) used to connect to the OMi server. Default value is: |
-stype, -scripttype <type> |
Sets the script type. |
-su, -syncupdates <yes|no> |
Enables or disables backsync of events updates to the connected server. The default is |
-toc <yes/no> |
Enables or disables transfer control to external server. Default value is: |
-type <server> |
Sets the type of server. The supported types are:
|
-u, -update <identifier> |
Updates the properties of the server specified by the ID or the name of the server. |
-url <URL> |
Sets the URL of the OMi server. Do not use in conjunction with the options |
-user, -username <log-in name> |
Sets the name of the OMi user. |
-version |
Shows the version of the ConnectedServer CLI. |
-wc, -winCrypto |
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. |
-wsrooturl <url> |
Sets the root URL of the web service. Default value is empty. |
Exit Status
Exit Value |
Description |
---|---|
0 |
Successful completion |
1 |
Failure of requested operation |
300-399 |
HTTP Redirection (300-399) |
400-499 |
HTTP Client Error (400-499) |
500-599 |
HTTP Internal Server Error (500-599) |
The exit status numbers (300-599) reflect a standard HTTP-status category (and number), for example: Redirection (300-399)
. For more information about a specific HTTP error status, for example: 307
, which signifies a temporary HTTP re-direct, see the publicly available HTTP documentation.
Restrictions
The user running the ConnectedServer command-line interface must be an OMi user with permission to create connected servers.
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
General example command syntax and command option and arguments for adding and updating specific server types are summarized in the following sections:
List servers:
ConnectedServer <<CONNECTION_INFO>> -list
Delete a server:
ConnectedServer <<CONNECTION_INFO>> -delete <identifier>
Show a server:
ConnectedServer <<CONNECTION_INFO>> -show <identifier>
Adding a server of type OMi:
ConnectedServer <<CONNECTION_INFO>> -add -type OMI -label <label> -name <name> [-desc <description>] -dns <dnsname> [-active <yes|no>] [-syncupdates <yes |no>] [-fwdtopo <yes | no>] [-dm <serial | serial_per_source | parallel[count]>] [-drilldns <dnsname> -drillport <port> [-drillssl <yes|no>]]
Updating a server of type OMi:
ConnectedServer <<CONNECTION_INFO>> -update <identifier> [-label <label>] [-name <name>] [-desc <description>] [-dns <dnsname>] [-active <yes|no>] [-syncupdates <yes|no>] [-fwdtopo <yes | no>] [-dm <serial | serial_per_source | parallel[count]>] [-drilldns <dnsname> -drillport <port> [-drillssl <yes|no>]]
Adding a server of type OM for Windows or OM for UNIX:
ConnectedServer <<CONNECTION_INFO>> -add -type <OMW|OMU> -label <label> -name <name> [-desc <description>] -dns <dnsname> [-active <yes|no>] [-syncupdates <yes|no>] [-fwdtopo <yes|no>] [-dm <serial | serial_per_source | parallel[count]>] -integrationuser <user> (([-integrationpw <pw>] [-integrationport <port>] [-issl <yes|no> [-certificatefile <file> | -certificate]) | [-other_server <id>])
Updating a server of type OM for Windows or OM for UNIX:
ConnectedServer <<CONNECTION_INFO>> -update <identifier> [-label <label>] [-name <name>] [-desc <description>] [-dns <dnsname>] [-active <yes|no>] [-syncupdates <yes|no>] [-fwdtopo <yes|no>] [-dm <serial | serial_per_source | parallel[count]>] [-integrationuser <user>] (([-integrationpw <pw>] [-integrationport <port>] [-issl <yes|no> [-certificatefile <file>]) | [-other_server <id>])
Adding a server of type External Processing:
ConnectedServer <<CONNECTION_INFO>> -add -label <label> -name <name> [-desc <description>] -dns <dnsname> -type EXTERNAL_PROCESS [-active <yes|no>] [-dm <serial | serial_per_source | parallel[count]>] (((-scriptfile <name> [-scripttype <type>] [-scriptcp <classpath>]) | -script_id <id>) | (-wsrooturl <url> [-bt <yes|no>])) [-maxtimeout <max_time>] ([-integrationuser <user>] [-integrationpw <pw>] [-integrationport <port>] [-issl <yes|no>]) ([-drilldns <dnsname> -drillport <port> [-drillssl <yes|no>]) (([-toc no] ([-backsync no] | [-backsync yes -backsyncpw <pw>]) | ([-toc yes -backsyncpw <pw>]))
Updating a server of type External Processing:
ConnectedServer <<CONNECTION_INFO>> -update <identifier> [-label <label>] [-name <name>] [-desc <description>] [-dns <dnsname>] [-active <yes|no>] [-dm <serial | serial_per_source | parallel[count]>] (((-scriptfile <name> [-scripttype <type>] [-scriptcp <classpath>]) | -script_id <id>) | (-wsrooturl <url> [-bt <yes|no>])) [-maxtimeout <max_time>] ([-integrationuser <user>] [-integrationpw <pw>] [-integrationport <port>] [-issl <yes|no>]) ([-drilldns <dnsname> -drillport <port> [-drillssl <yes|no>]) (([-toc no] ([-backsync no] | [-backsync yes -backsyncpw <pw>]) | ([-toc yes -backsyncpw <pw>]))
Adding a server of type Operations Connector:
ConnectedServer <<CONNECTION_INFO>> -add -type BSM_CONNECTOR -label <label> -name <name> [-desc <description>] -dns <dnsname> [-active <yes|no>] [-syncupdates <yes|no>] [-dm <serial | serial_per_source | parallel[count]>] [-integrationport <port>] [-issl <yes|no>] [-drilldns <dnsname> -drillport <port> [-drillssl <yes|no>]] [-failover <dnsname>] [-wsrooturl <url>]]
Updating a server of type Operations Connector:
ConnectedServer <<CONNECTION_INFO>> -update <identifier> [-label <label>] [-name <name>] [-desc <description>] [-dns <dnsname>] [-active <yes|no>] [-syncupdates <yes|no>] [-dm <serial | serial_per_source | parallel [count]>] [-integrationport <port>] [-issl <yes|no>] ([-drilldns <dnsname> -drillport <port> [-drillssl <yes|no>]) [-failover <dns name>] [-wsrooturl <url>]]
Alternative:
To set up an OpsCx server in Operations Management, use the Integrations manager in Admin > Integrations > Operations Connector. Setting up an OpsCx in the Integrations manager automatically creates an OpsCx connected server in the Connected Servers manager.
Caution
The OpsCx connected server is only a copy of the OpsCx server in the Integrations manager and has fewer attributes than the original OpsCx server in the Integrations manager. The Connected Servers manager and the ConnectedServers command-line interface do not offer advanced configuration of OpsCx servers, such as event integration or topology settings.
Although it is possible to configure a server in the Connected Servers manager or using the ConnectedServers command-line interface, it is not recommended because the Connected Server manager and command do not create a corresponding server in the Integrations manager.
Do not edit or delete an OpsCx server in the Connected Server manager. Operations Management does not synchronize the changes with the Integrations manager. Deleting an OpsCx connected server, disables drilldown and event synchronization.
To configure a server for OpsCx, see How to create a connection to an Operations Connector (OpsCx) server.
Adding a server of type ArcSight:
ConnectedServer <<CONNECTION_INFO>> -add -label <label> -name <name> [-desc <description>] -dns <dnsname> -type ARC_SIGHT [-active <yes|no>]
Updating a server of type ArcSight:
ConnectedServer <<CONNECTION_INFO>> -update <identifier> [-label <label>] [-name <name>] [-desc <description>] [-dns <dnsname>] [-active <yes|no>]
Adding a server of type SiteScope:
ConnectedServer <<CONNECTION_INFO>> -add -type SITE_SCOPE -label <label> -name <name> [-desc <description>] [-active <yes|no>] [-defaultserver] -dns <dns name> [-integrationuser <user>] [-integrationpw <password>] [-integrationport <port>] [-issl <yes>|<no>] [-operating_system <os>] [-server_version <server version>] [-omiuser <OMi user>] [-omipassword <password>] [-proxydns <dns name>] [-proxyuser <user>] [-proxypw <password>] [-proxyport <port>] [-defaultroutingdomain <routing domain>] [-resynctimeinterval <days>]
Updating a server of type SiteScope:
ConnectedServer <<CONNECTION_INFO>> -update <identifier> [-label <label>] [-name <name>] [-desc <description>] [-active <yes|no>] [-defaultserver] [-dns <dns name>] [-integrationuser <user>] [-integrationpw <password>] [-integrationport <port>] [-issl <yes>|<no>] [-operating_system <os>] [-server_version <server version>] [-omiuser <OMi user>] [-omipassword <password>] [-proxydns <dns name>] [-proxyuser <user>] [-proxypw <password>] [-proxyport <port>] [-defaultroutingdomain <routing domain>] [-resynctimeinterval <days>]
Note In the case of the SiteScope connected server, -integrationuser
specifies the SiteScope user, and -omiuser
specifies the OMi administrator user that SiteScope should use to call OMi.
Note If you only have one SiteScope Connected Server configured, it is always used as the target for deploying monitors.
For environments with multiple SiteScope servers, OMi, by default, selects the SiteScope server with the most free license points as the target for deployment.
If there is more than one SiteScope server with a sufficient number of free license points, OMi chooses one server at random. To prevent OMi from randomly selecting the SiteScope server to be used for deployment, configure a Groovy server selection script.
Deleting a server of type SiteScope:
ConnectedServer <<CONNECTION_INFO>> -delete <identifier>
Note The default SiteScope Connected Server cannot be deleted if other SiteScope servers exist. In this case, the delete operation fails and an error is reported.
To solve this problem:
-
Set another SiteScope server as default by using
ConnectedServer <<CONNECTION_INFO>> -update <identifier> -defaultserver
. -
Perform the delete operation.
Adding a server of type APM:
ConnectedServer <<CONNECTION_INFO>> -add -type APM -label <label> -name <name> [-desc <description>] -dns <dnsname> [-active <yes|no>] -integrationuser <user> -integrationpw <password> -integrationport <port> -issl <yes|no> [-syncupdates <yes|no>] [-wsrooturl <url>] [-synchronizetopology <yes|no> -globalidgenerator <yes|no> -dataflowprobename <data flow probe name> -domainname <data flow probe domain name>] [-omiapmsetup <yes|no>] [-synchronize <yes|no> [-syncrhonizedowntime <yes|no>]]
Updating a server of type APM:
ConnectedServer <<CONNECTION_INFO>> -update <identifier> [-label <label>] [-name <name>] [-desc <description>] [-dns <dnsname>] [-active <yes|no>] [-integrationuser <user>] [-integrationpw <password>] [-integrationport <port>] [-issl <yes|no>] [-syncupdates <yes|no>] [-wsrooturl <url>] [-synchronizetopology <yes|no> -globalidgenerator<yes|no> -dataflowprobename <data flow probe name> -domainname <data flow probe domain name>] [-omiapmsetup <yes|no>] [-synchronize <yes|no> [-synchronizedowntime <yes|no>]
Adding a server of type BVD:
ConnectedServer <<CONNECTION_INFO>> -add -label <label> -name <name> [-desc <description>] -type BVD [-username <log-in name>] [-password <password>] [-dns <dnsname>] [-active <yes|no>] [-integrationport <port>] [-issl <yes|no>] [-wsrooturl <API_key_URL>]
Updating a server of type BVD:
ConnectedServer <<CONNECTION_INFO>> -update <identifier> [-label <label>] [-name <name>] [-desc <description>] [-dns <dnsname>] [-active <yes|no>]
Adding a server of type Alias:
ConnectedServer <<CONNECTION_INFO>> -add -label <label> -name <name> -type ALIAS [-active <yes|no>] [-other_server <id>]
Updating a server of type Alias:
ConnectedServer <<CONNECTION_INFO>> -update <identifier> [-label <label>] [-name <name>] [-desc <description>] [-dns <dnsname>] [-active <yes|no>] [-other_server <id>]
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: