Get Started with Command-Line Interfaces

cvinit

Start/Stop Exalead CloudView

To perform basic start/stop/restart operations on your Exalead CloudView instance, go to the <DATADIR>/bin directory and run the command-line scripts as described below:


To...	Use
Start Exalead CloudView	`cvinit.[bat\|sh] start`
Stop Exalead CloudView	`cvinit.[bat\|sh] stop`
Restart Exalead CloudView	`cvinit.[bat\|sh] restart`
Get the status of the Exalead CloudView processes.	`cvinit.[bat\|sh] status`
Force Exalead CloudView to stop.	`cvinit.[bat\|sh] kill`

Note: In Windows environments, you can use the Microsoft Management Console to start and stop the registered service or use the command line. For example, to start the product: net start "Exalead CloudView Search - cvdefault".

Advanced Operations

To perform advanced operations on your instance, go to the <DATADIR>/bin directory and run the command-line scripts as described below:


To...	Use
Wait until the start of all Exalead CloudView processes	`cvinit.[bat\|sh] wait-started`
Check that indexes are up on a host	`cvinit.[bat\|sh] check-indexes-up`
Detach a Exalead CloudView host from the primary server (to run on secondary server) For more information, see Detach Indexes from the Replication Process.	`cvinit.[bat\|sh] detach` OR use method: `detachHost` in API Console
Attach a Exalead CloudView host to the primary server (to run on secondary server) For more information, see Detach Indexes from the Replication Process.	`cvinit.[bat\|sh] attach` OR use method: `attachHost` in API Console
Force 'isAlive' health monitors on a host as down For more information, see Safely Stop Indexes.	`cvinit.[bat\|sh] set-not-alive`
Force 'isAlive' health monitors on a host as up For more information, see Safely Stop Indexes.	`cvinit.[bat\|sh] set-alive`
Return whether the 'isAlive' health monitors have been forced as down For more information, see Safely Stop Indexes.	`cvinit.[bat\|sh] is-alive`

cvcommand and cvcmd

What Is the Difference


Tool	Purpose	Example
`cvcommand`	Sends HTTP requests to the product gateway. The service can be any valid service mounted on the gateway.	To display a build group status, run: `cvcommand myhost:10011 /mami/indexing getBuildGroupStatus buildGroup=bg0` or go to: `http://myhost:10011/mami/indexing/getBuildGroupStatus?buildGroup=bg0`
`cvcmd`	Sends commands using the `command` service only.	To test a configuration, run: `cvcmd testConfig` or `cvcommand myhost:10011 command testConfig`

Use cvcommand

The cvcommand is a command-line tool located in the <DATADIR>\bin directory. Its syntax is the following:

cvcommand [options] gw service method [args]

Where:

gw: gateway address (http://path_to_gateway or host:port or :port)
service: name of the service
method: name of the method
args: argument list in the form name=value

Options:

help|-h: displays the help
timeout|-t seconds: number of seconds to wait for an answer

Error codes:

cvcommand returns a 0 error code if operation is successful. You can get the error code:

On UNIX, using "echo $?".
On MS Windows, using echo %ERRORLEVEL%.

Common Scripts


To...	Use...
Display help messages	`cvcommand -h` or `cvcmd help`
Display status process list	`cvcommand host:10011 command status` or `cvcmd status`
Run `cvcommand` from another machine	`cvcommand myhost:10011 command status`
Run `cvcommand` from another machine, which has only access to the gateway through an http proxy (`http://gateway.mycompany/gateway`)	`cvcommand GATEWAYURL/gateway command status`
Test the configuration before applying	`cvcommand myhost:10011 command testConfig`
Apply the configuration	`cvcommand myhost:10011 command applyConfig`
Specify logging level to `DEBUG`	`cvcommand myhost:10011 command setLoggingLevel level=debug`
Get the exhaustive list of available internal services	`cvcommand myhost:10011 directory getServices`
Get the list of service descriptions	`cvcommand myhost:10011 directory getSchemas`
Retrieve errors logged in `log.log` using filters (date, component, level)	`cvcommand` `myhost:10011 /mami/master getGlobalLogEntryList (startDate, endDate, maxEntries, codeFilter, componentFilter, levelFilter)`
Display build group status (analysis, import, indexing)	`cvcommand myhost:10011 /mami/indexing getBuildGroupStatus buildGroup=mybuildgroup`
Enable, for a given index build group: - Analysis - Import	`cvcommand myhost:10011 /mami/indexing enableAnalysis buildGroup=mybuildgroup` `cvcommand myhost:10011 /mami/indexing enableAnalysis buildGroup=mybuildgroup`
Disable, for a given index build group: - Analysis - Import	`cvcommand myhost:10011 /mami/indexing disableAnalysis buildGroup=mybuildgroup` `cvcommand myhost:10011 /mami/indexing disableImport buildGroup=mybuildgroup`
Display the list of analysis configuration	`cvcommand myhost:10011 /mami/indexing getAnalysisConfigList`
Clear an index build group	`cvcommand myhost:10011 /mami/indexing clearBuildGroup buildGroup=mybuildgroup`

cvdebug

cvdebug is a command-line tool, which allows you to perform advanced analysis and indexing debug. The cvdebug tool is in the <DATADIR>\bin directory.

To dump an index:

cvdebug index print slice=1 buildGroup=mybuildgroup > /path_to_output_file

To submit a document to test processors in the pipeline:

cvdebug analysis analyze path=<PATH_TO_DOCUMENT>

For more information, see cvdebug.