Page tree

Use this command to stop collection of all data collectors together or particular data collectors as per the criterion specified. Additionally, you can preview the data collectors that will be affected by the criterion that you specify.

To understand the syntax and examples, see:

Related topics

Syntax

Note

Prefix this command with the following, as appropriate:

  • For Windows: itda.bat
  • For Linux: ./itda.sh

stopCollection -u <userName> -w <password> -d <hostName> -p <portNumber> 
-c <criterion> [-y] [-v] [-s]
  • Angle brackets (< >) indicate a variable value that needs to be user defined.
  • Square brackets ([ ]) indicate optional parameters.

The following table describes the parameters used in the syntax:

ParameterDescription
-u
MultiExcerpt named username was not found -- Please check the page name and MultiExcerpt name used in the MultiExcerpt-Include macro
-w
MultiExcerpt named password was not found -- Please check the page name and MultiExcerpt name used in the MultiExcerpt-Include macro
-d
MultiExcerpt named host was not found -- Please check the page name and MultiExcerpt name used in the MultiExcerpt-Include macro
-p
MultiExcerpt named port was not found -- Please check the page name and MultiExcerpt name used in the MultiExcerpt-Include macro
-c

Criterion to select data collectors for which you need to be stop collection.

This parameter must be specified in the format key=value, as follows:

  • collectorName="<Data Collector Name>"
    where <Data Collector Name> refers to the name of the data collector that must be stopped.
  • hostName="<Host Name>"
    where <Host Name> refers to the name of the host associated with the data collectors that need to be stopped.
    To stop collection for all the data collectors, specify _ALL_ as the value.

Notes:

  • To stop multiple data collectors with a similar name, you can use asterisk (*) as a wildcard character to substitute portions of the value. For example, collectorName="*access*".
  • The value provided must be enclosed in double quotes.
-y
MultiExcerpt named preview was not found -- Please check the page name and MultiExcerpt name used in the MultiExcerpt-Include macro
-v
MultiExcerpt named version was not found -- Please check the page name and MultiExcerpt name used in the MultiExcerpt-Include macro
-s
MultiExcerpt named ssl was not found -- Please check the page name and MultiExcerpt name used in the MultiExcerpt-Include macro

Example inputs

The following example provides the input for stopping the collection of data collectors starting with the name houston:

stopCollection -u admin -w admin -d localhost -p 9797 -c hostName=”houston*”

The following example provides the input for stopping the collection of all data collectors:

stopCollection -u admin -w admin -d localhost -p 9797 -c hostName=_ALL_