deletecollector CLI command

Use this command to delete data collectors based on the criterion specified. Additionally, you can preview the data collectors that will be affected by the criterion that you specify. You can also delete the data indexed by those data collectors.


You cannot use this command to delete all data collectors.

To understand the syntax and examples, see:



Before you run the command, note the following points:

deleteCollector -u <userName> -w <password> -d <hostName> -p <portNumber> -c <criterion> [-l <locale>] [-y][-r][-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:

User name to use to connect with the Console Server.
Password corresponding to the user name to use to connect with the Console Server.
Host name of the Console Server.
Port number of the Console Server.

Criterion to select data collectors that must be deleted.

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 you want to delete.
  • hostName="<Host Name>"
    where <Host Name> refers to the name of the host associated with the data collectors that you want to delete.


  • The value provided must be enclosed in double quotes.
  • To delete 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*".

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


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

(Optional) Delete data indexed by the selected data collectors.
(Optional) Version of the IT Data Analytics product.
(Optional) Indicates an HTTPS connection.

Example input

The following example provides the input for deleting the data collectors associated with host name starting with houston:

deleteCollector -u admin -w admin12345 -d localhost -p 9797 -c hostName="houston*" -r

Was this page helpful? Yes No Submitting... Thank you