editcollector CLI command
Use this command to add or delete tags for an existing data collector.
To understand the syntax and examples, see:
Syntax
Note
Before you run the command, note the following points:
- Set up the CLI. For more information, see Managing the product from the command line interface.
- Prefix this command with the following, as appropriate:
- For Windows: itda.bat
- For Linux: ./itda.sh
editcollector -u <userName> -w <password> -d <hostName> -p <portNumber> -n <CollectorName> -addtag <TagName=TagValue> -deltag <TagName=TagValue> [-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:
Parameter | Description |
---|---|
-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:
|
-addtag | Tags that you want to add to the specified data collector. This parameter must be specified in the format, For example, to add the tag, OS=Windows, you need to specify the following criterion:
You can specify multiple tag name=value pairs by specifying a space-separated list and by preceding the name=value pair with the parameter, For example, Notes:
|
-deltag | Tags that you want to delete to the specified data collector. This parameter must be specified in the format, For example, to delete the tag, OS=Windows, you need to specify the following criterion:
You can specify multiple tag name=value pairs by specifying a space-separated list and by preceding the name=value pair with the parameter, For example, Notes:
|
-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:
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:
Example: If you want to set the locale as Simplified Chinese, you need to specify, |
-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"
Comments