list

Use this command to list all supported entities.

To understand the syntax and examples, see:

Related topics

Where to find more information

Managing saved searches

Managing data patterns

Managing workspaces

Managing components

Managing data collectors

Using the command line interface

Syntax

Note

Prefix this command with the following, as appropriate:

For Windows: itda.bat
For Linux: ./itda.sh

list –u <userName> [-v] [-s] –w <password> –d <hostName> –p <portNumber> –e <entityName>

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:

Parameter	Description
-d	MultiExcerpt named host was not found -- Please check the page name and MultiExcerpt name used in the MultiExcerpt-Include macro
-e	The name of the entity that you want to list
-p	MultiExcerpt named port was not found -- Please check the page name and MultiExcerpt name used in the MultiExcerpt-Include macro
-u	MultiExcerpt named username was not found -- Please check the page name and MultiExcerpt name used in the MultiExcerpt-Include macro
-v	MultiExcerpt named version was not found -- Please check the page name and MultiExcerpt name used in the MultiExcerpt-Include macro
-w	MultiExcerpt named password was not found -- Please check the page name and MultiExcerpt name used in the MultiExcerpt-Include macro
-s	MultiExcerpt named ssl was not found -- Please check the page name and MultiExcerpt name used in the MultiExcerpt-Include macro

Supported entities

You can use this command to list the following entities:

Data collectors
Workspaces
Saved searches
Data patterns
Components

Example input

The following example provides the input for listing supported entities:

list -u admin -w admin -d localhost -p 9797 -e component
 
list -u admin -w admin -d localhost -p 9797 -e collector
 
list -u admin -w admin -d localhost -p 9797 -e datapattern
 
list -u admin -w admin -d localhost -p 9797 -e savedsearch
 
list -u admin -w admin -d localhost -p 9797 -e workspace

Page tree

list

Syntax

Supported entities

Example input