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

Use this command to add or delete tags for an existing data collector.

Syntax

Note

Before you run the command, note the following points:

editcollector -u <userName> -w <password> -d <hostName> -p <portNumber> -n <CollectorName> -addtag <TagName=TagValue> -deltag <TagName=TagValue> [-v] [-s] [-l <locale>]

In the preceding syntax, angle brackets (< >) indicate a variable value that needs to be user defined.

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

Data collector name for which you want to add tags or delete existing tags.

Notes:

  • At a time you can add tags or delete tags for only one data collector.
  • If the data collector name contains spaces, then you need to enclose the name in double quotes. For example, -n "CLM Collector".
-addtag

Tags that you want to add to the specified data collector.

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

For example, to add the tag, OS=Windows, you need to specify the following criterion:

-addtag OS=Windows

You can specify multiple tag name=value pairs by specifying a space-separated list and by preceding the name=value pair with the parameter, -addtag.

For example, -addtag OS=Windows -addtag OS=Linux -addtag location=Houston.

Notes:

  • At a time, you can only specify one tag name=value pair.
  • While specifying the tag name=value pair, you cannot specify a list of multiple values. But you can provide multiple name=value pairs.
  • If the tag value contains a space, then you need to enclose the tag value in double quotes. For example, -addtag OS="Windows 1".
-deltag

Tags that you want to delete to the specified data collector.

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

For example, to delete the tag, OS=Windows, you need to specify the following criterion:

-deltag OS=Windows

You can specify multiple tag name=value pairs by specifying a space-separated list and by preceding the name=value pair with the parameter, -deltag.

For example, -deltag OS=Windows -deltag OS=Linux -deltag location=Houston.

Notes:

  • At a time, you can only specify one tag name=value pair.
  • While specifying the tag name=value pair, you cannot specify a list of multiple values. But you can provide multiple name=value pairs.
  • If the tag value contains a space, then you need to enclose the tag value in double quotes. For example, -deltag OS="Windows 1".
-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 adding and deleting tags for the data collector, Windows Events:

editcollector -u admin -w admin12345 -d localhost -p 9797 -n "Windows Events" -addtag OS=Windows -addtag OS=Linux -deltag Tier="Tier 1"