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

Use this command to list all supported entities.

 Syntax

Note

Before you run the command, note the following points:

list –u <userName> –w <password> –d <hostName> –p <portNumber> –e <entityName> [-l <locale>] [-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
-d
Host name of the Console Server
-e
The name of the entity that you want to list
-p
Port number of the Console Server.
-u
User name to use to connect with the Console Server.
-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.
-w
Password corresponding to the user name to use to connect with the Console Server.
-s
(Optional) Indicates an HTTPS connection.

Supported entities

You can use this command to list the following entities:

  • Data collectors
  • Saved searches
  • Data patterns
  • Components

Example input

The following example provides the input for listing supported entities:

list -u admin -w admin12345 -d localhost -p 9797 -e component

list -u admin -w admin12345 -d localhost -p 9797 -e collector

list -u admin -w admin12345 -d localhost -p 9797 -e datapattern

list -u admin -w admin12345 -d localhost -p 9797 -e savedsearch