Page tree
Skip to end of metadata
Go to start of metadata

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:

Syntax

Note

Before you run the command, note the following points:

stopCollection -u <userName> -w <password> -d <hostName> -p <portNumber> -c <criterion> -tag <TagName=TagValue> [-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
User name to use to connect with the Console Server.
-w
Password corresponding to the user name to use to connect with the Console Server.
-d
Host name of the Console Server
-p
Port number of the Console Server.
-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, you must specify the value, _ALL_.

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.
-tag

Tag name and corresponding value to use as a criterion for selecting data collectors for which you need to stop collection.

This parameter must be specified in the format TagName=TagValue.

For example, to stop all data collectors associated with the tag OS=Windows, you need to specify the following criterion:

-tag OS=*Windows*

You can use asterisk (*) as a wildcard character to substitute portions of the tag value. For example -tag OS=Win*.

Notes:

  • At a time, you can only specify one tag name=value pair.
  • You cannot specify more than one value for the same tag name as the criterion.
  • Wildcard support is not provided for the tag name.
  • If the tag value contains an asterisk (*), then you need to escape it in the following way, depending on the platform you are using:
    • Windows: Precede the asterisk (*) with a backward slash (\), as follows:
      -tag OS=Win\*
    • Linux: Precede the asterisk (*) with two backward slashes (\\), as follows:
      -tag OS=Win\\*
-y

(Optional) Preview the status of the data collectors that will be affected by this command.

Note: This parameter only provides a preview and does not actually run the command. To run the command, you must exclude this parameter.

-l

(Optional) Indicates the locale in which you want to display messages when the command is run.

You can set one of the following locales:

  • English
  • Simplified Chinese
  • German
  • French

By default, the messages are displayed in the locale of the system on which the CLI is run.

The value can be set to one of the following depending on the locale you choose:

  • English: en
  • Simplified Chinese: chs
  • German: de
  • French: fr

Example: If you want to set the locale as Simplified Chinese, you need to specify, l=chs.

-v
(Optional) Version of the IT Data Analytics product.
-s
(Optional) Indicates an HTTPS connection.

Example inputs

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

stopCollection -u admin -w admin12345 -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 admin12345 -d localhost -p 9797 -c hostName=_ALL_

The following example provides the input for stopping the collection of data collectors based on the following criteria:

  • Data collectors associated with the tag name=value as OS=Windows.
  • Data collectors starting with the name SSH.

stopCollection -u admin -w admin12345 -d localhost -p 9797 -c collectorName=”SSH*” -tag OS=Windows