Forward OMi KPI Status

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)`

Use the bvd-kpi-status command-line interface to forward KPI status data from OMi to BVD.

BVD data channels opened up by the bvd-kpi-status command-line interface:

omi<>kpi<>viewName<>ciName<>kpiName

omi

kpi

viewName

ciName

kpiName

Options

Option	Description
`{‑view_name\|‑vn} <View Name>`	Sets the name of the view for which KPI status data will be collected.
`{-kpi_name\|-kn} <KPI Name>`	Sets the name of the KPI for which status data will be collected. If omitted, bvd-kpi-status sends the status of all KPIs for all CIs that are related to the given view name.
`{‑polling_interval\|‑pi} <Polling Interval>`	Sets the polling interval (in milliseconds) for collecting event status data. Default: 10,000 milliseconds (10 seconds)
`{‑dashboard_config\|‑dc} <BVD Config File>`	Sets the path to the BVD configuration file `bvdconf.json`. If omitted, it assumes the file in the following directory: Windows: `%OvDataDir%\shared\server\conf\opr\bvdconf.json` Linux: `/var/opt/OV/shared/server/conf/opr/bvdconf.json`
`{‑post2\|‑p2}`	For internal use only.
`{‑help\|‑h}`	Displays a summary of the command options.
`{-verbose\|-v}`	Prints verbose output.
`‑version`	Displays version information for the tool.

Syntax for <connection>

-username <login name> [ -password <password> | -smartcard | -winCrypto | -jks <keystore path> -jksPassword <keystore password> ] [[-port <port>] [-server <gatewayserver>] [-ssl]]

Note If you do not specify the OMi server to connect to (using the ‑server option), the command is executed on the server to which you are logged on.

Option	Description
`{-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}`	Uses the certificate stored on smart card or security token for authentication.
`{-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.
`{-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.
`{-jksPassword\|-jp} <keystore password>`	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.
`{-port\|-p} <port>`	Uses port `<port>` to connect to the target gateway server. Default value of `<port>`: `80` for HTTP connections `443` for HTTPS connections
`-server <GatewayServer>`	Sets the target gateway server, using `<GatewayServer>` as the hostname or IP address to locate it. Default value of `<GatewayServer>`: 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.

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)