Commands, return codes, and session IDs
You can use commands to diagnose problems, determine the status of the different parts of the system, start and stop sessions, or start and stop the system.
In a multiple server installation, you can run the commands from any server in your system. However, you should run the commands from the master server. The master server can access information from all other servers in the system.
esadmin command_name arguments
esadmin session_ID action -option
For more information about all commands, enter esadmin help. For more information about a specific command, enter esadmin action help.
- System-wide esadmin commands
- Component-specific esadmin commands. Some component-specific status commands can return extensive information. This following sections describe the detailed information that can be returned from various status commands:
- Web crawler status
- Crawl space status for the Web crawler
- Detailed crawl space status for the Web crawler
- Detailed status for severs crawled by the Web crawler
- Non-Web crawler status
- Crawl space status for non-Web crawlers
- Detailed crawl space status for non-Web crawlers
- Parser status
- Search server status
System-wide esadmin commands
Enter the following commands on one line.
Command | Description |
---|---|
|
Starts the system components on all servers.
Starts the common communication layer (CCL) on the local server only.
To recycle the CCL, you must manually stop and restart the CCL on
each remote server. Sample command:
|
|
Stops the system components on all servers.
Stops the CCL on the local server only. To recycle the CCL, you must
manually stop and restart the CCL on each remote server. Sample
command:
|
|
Checks the status of all components on all servers. Sample
command:
|
|
Exports the query statistics history to a file
in CSV format. If you omit the range option, all kept history records
are written to the file. With the range option, records from the specified from_hours_before value
to the to_hours_before value are written to the
file. Sample command: Export all records:
Sample command: Export
records from the past 24 hours (from 24*60 minutes until the current
time):
Sample
command: Export records up until 24 hours ago:
Sample
messages and return codes:
|
Component-specific esadmin commands
Enter the following commands on one line.
Command | Description |
---|---|
|
Starts a crawler session. This command does
not start any crawling activity. Sample command:
Sample
messages and return codes:
|
|
Applicable only to data source (non-Web) crawlers.
Starts the crawler to crawl new, modified, and deleted documents.
Use -options 2 to start a full crawl or -options
3 to start crawling new and modified documents only. Sample
commands:
Sample
messages and return codes:
|
|
Pauses crawling. Sample command:
Sample
messages and return codes:
|
|
Resumes crawling. Sample command:
Sample
messages and return codes:
|
|
Stops crawling. Sample command:
Sample
messages and return codes:
|
|
Stops a crawler session. Sample command:
Sample
messages and return codes:
|
|
Gets the status of a crawler. The information
that is returned depends on whether the crawler is a Web crawler or
a crawler for all other data sources. Example for a Web crawler:
Possible
return codes and messages for a Web crawler:
Example for a non-Web crawler:
Possible
return codes and messages for a non-Web crawler:
For more information about returned status messages, see Web crawler status and Non-Web crawler status. |
|
Gets general crawl space status for any crawler other than the Web crawler. Sample command:
Sample
messages and return codes:
For more information about status messages, see Non-Web crawler status. |
|
Gets general crawl space status for the Web crawler. Sample command:
For
more information about returned status messages, see Web crawler status. For descriptions
of the values that you can specify for the |
|
Gets detailed crawl space status for any crawler other than a Web crawler. If you do not specify the target server option, data for all target servers is returned. For example, if the DB2 crawler crawls the FOUNTAIN and SAMPLE databases and you do not specify the target server option, the status of all tables in the FOUNTAIN and SAMPLE databases is returned. Sample
command:
Sample
messages and return codes:
For more information about returned status messages, see Non-Web crawler status. |
|
Gets detailed crawl space status for the Web crawler. Sample command:
For
more information about returned status messages, see Web crawler status. For descriptions
of the values that you can specify for the |
|
Gets the parser status. Sample command:
Sample messages and return codes:
|
|
Start an index build. Sample command:
|
|
Stop an index build. Sample command:
|
|
Starts the search server processes. Sample
command:
Sample
messages and return codes:
|
|
Stops the search server processes. Sample
command:
Sample
messages and return codes:
|
|
Gets the status of the search server. Sample
command:
Sample messages and return codes:
Returns detailed search index status information for a collection on a given search server. There is one search manager session per search server. Each search manager session is responsible for monitoring and operating the search indexes on a specific search server. Sample
command:
Sample
messages and return codes:
Sample
command:
Sample
messages and return codes:
For more information about returned status messages, see Search server status. |
Web crawler status
FFQC5314I Result: <?xml version='1.0' encoding='UTF-8'?>
<CrawlerStatus>
<CrawlerRunLevel Value="Running"/>
<CrawlerThreadStateDist Count="4" Total="200">
<CrawlerThreadState State="FETCHING" Count="100"/>
. . .
</CrawlerThreadState State="FETCHING" Count=100>
<ActiveBucketList Count="500">
<ActiveBucket URL="http://w3.ibm.com/"
NumActURLs="355"
NumProcURLs="350"
TimeRem="5" Duration="1195"/>
. . .
</ActiveBucketList>
<CrawlRate Value="75"/>
<RecentlyCrawledURLList Count="40">
<RecentlyCrawledURL URL="http://example.server.com/example.html"/>
<RecentlyCrawledURL URL="http://example.server.com/example.html"/>
<NumURLsThisSession Value="160000"/>
</CrawlerStatus>
Element | Attributes | Description |
---|---|---|
CrawlerStatus |
|
Crawler status. |
CrawlerRunLevel Value |
|
Information about what the crawler is doing. |
CrawlerThreadState State | String (English) | Crawler thread activity. This field shows what the thread or threads are doing. |
ActiveBucket |
|
The current activity of a specified Web site. |
CrawlRate | Value: Integer (nonnegative) Pages per second being crawled (all buckets combined). |
The crawler throughput measurement. |
RecentlyCrawledURL | URL: String (URL spec) String specifying a protocol, host, port and file that was crawled. |
A page that was crawled recently. |
NumURLsThisSession | Value: Integer (nonnegative) | The number of URLs that were crawled since this instance of the crawler (process) started crawling. |
Crawl space status for the Web crawler
When
you run the command to obtain crawl space status for a Web crawler,
the command returns information in an XML document format. The following
information can be returned by a Web crawl space status command. The selections
parameter
values are masks. For example, to see status information for mask
1 (Number of pages in raw data store) and status information for mask
2 (Number of discovered sites), add the mask values and specify -selections=3
.
Mask bit | Selects |
---|---|
1 | Number of pages in raw data store. |
2 | Number of discovered sites. |
4 | Number of sites with DNS. |
8 | Number of sites without DNS. |
16 | Number of discovered URLs. |
32 | Number of unique saved pages. |
64 | Number of crawled URLs. |
128 | Number of URLs that are uncrawled. |
256 | Number of URLs that are overdue. |
512 | HTTP status code distribution. |
<CrawlStatus>
<NumPagesInRDS Value="5422386"/>
<NumSitesDiscovered Value="15332"/>
<NumSitesWithDNS Value="14832"/>
<NumSitesWithoutDNS Value="500"/>
<NumURLsDiscovered Value="15222999"/>
<NumUniquePagesSaved Value="6234789"/>
<NumURLsCrawled Value="7800422"/>
<NumURLsUncrawled Value="7422577"/>
<NumURLsOverdue Value="14000"/>
<HTTPCodeDist Count="4" Total="1031000"/>
<HTTPCode Code="200" Count ="1000000"/>
<HTTPCode Code="301" Count ="1000"/>
<HTTPCode Code="404" Count ="10000"/>
<HTTPCode Code="780" Count="20000"/>
</HTTPCode Code="780" Count="20000">
<?CrawlStatus>
Element | Attribute | Description |
---|---|---|
CrawlerStatus |
|
Information that can be quickly obtained about the cumulative state of the crawl (all sessions). |
NumPagesInRDS | Value: Nonnegative integer How many pages are currently in the raw data store (RDS) staging area (from this crawler only). |
How full the raw data store (RDS) is becoming (from this crawler's contributions only). |
NumSitesDiscovered | Value: Nonnegative integer How many hosts were discovered by crawling (or from seeds). |
A measure of the crawler's coverage of the domain to be crawled (host count). |
NumSitesWithDNS | Value: Nonnegative integer How many hosts have associated IP addresses (resolved by the crawler in background). |
A measure of how effectively the crawler is able to get IP addresses for hosts that are discovered by DNS names in URLs. |
NumSitesWithoutDNS | Value: Nonnegative integer How many hosts do not have associated IP addresses (resolved by the crawler in background). |
A measure of how effectively the crawler is able to get IP addresses for hosts that are discovered by DNS names in URLs. |
NumURLsDiscovered | Value: Nonnegative integer How many unique URLs were visited by the crawler. |
A measure of the crawler's coverage of the domain to be crawled (URL count). |
NumUniquePagesSaved | Value: Nonnegative integer How many unique pages were written to the RDS for further processing by other components. |
This crawler's contribution to the size of the index. |
NumURLsCrawled | Value: Nonnegative integer How many unique URLs were crawled by the crawler. |
A measure of the crawler's ability to process data, end to end. This number is different from the number of pages written to RDS, because not all crawled pages result in being written to RDS. |
NumURLsOverdue | Value: Nonnegative integer How many unique URLs are eligible to be recrawled. |
A measure of the crawler's ability to traverse the Web space. |
Detailed crawl space status for the Web crawler
When you run the command to obtain detailed crawl
space status for the Web crawler, the command returns information
in an XML document format. The following information can be returned
by the detailed crawl space status command. The selections
parameter
values are masks. For example, to see status information for mask
1 (Number of pages in raw data store) and status information for mask
2 (Number of discovered sites), add the mask values and specify -selections=3
.
Mask bit | Selects |
---|---|
1 | Number of pages in raw data store. |
2 | Number of discovered sites. |
4 | Number of sites with DNS. |
8 | Number of sites without DNS. |
16 | Number of discovered URLs. |
32 | Number of unique saved pages. |
64 | Number of crawled URLs. |
128 | Number of URLs that are uncrawled. |
256 | Number of URLs that are overdue. |
512 | HTTP status code distribution. |
<CrawlDetailsPerSite>
<Site URL=http://w3.ibm.com/">
<NumURLsDiscovered Value="5422386"/>
<NumURLsOverdue Value="15332"/>
<NumURLsCrawled Value="15332"/>
<NumURLsUncrawled Value="15332"/>
<NumURLsOverdueBy Threshold=”604800” Value="14832"/>
<NumURLsActivated Value=”2200"/>
<LastActivationTime Value="1076227340"/>
<LastActivationDuration Value="4300"/>
<IPAddressList Count="1"/>
<IPAddress Value=“9.205.41.33"/>
</IPAddressList>
<RobotsContent>
robots content. . .
</RobotsContent>
<HTTPCodeDist Count="4" Total="1031000"/>
<HTTPCode Code="200" Count ="1000000"/>
<HTTPCode Code="301" Count ="1000"/>
<HTTPCode Code="404" Count ="10000"/>
<HTTPCode Code="780" Count="20000"/>
</HTTPCodeDisT>
</CrawlDetailsPerSite>
Element | Attributes | Description |
---|---|---|
CrawlDetailsPerSite |
|
Information that can be quickly obtained about the detailed state of one site. |
Site | URL | URL of the site root page. |
NumURLsDiscovered | Value | The number of URLs that were discovered from the site. |
NumURLsOverdue | Value | The number of URLs that are eligible to be recrawled from the site. |
NumURLsCrawled | Value | The number of URLs that were crawled for the site. |
NumURLsUncrawled | Value | The number of URLs that are not yet crawled for the site. |
NumURLsOverdueBy | Threshold, Value: Integer (positive or negative) The value represents the number of URLs that are eligible to be recrawled. The threshold specifies the amount of time that the URLs have been waiting to be recrawled. The threshold is measured as the number of seconds offset from the current time. If the threshold is negative, it means that a recrawl of the URLs is overdue. If the threshold is positive, it means that a recrawl of the URLs is due to occur. |
The number of URLs that became eligible to be recrawled at least some number of seconds ago or that are becoming eligible to be recrawled in the next so many seconds. |
NumURLsActivated | Value | Number of URLs brought into memory during the last scan of this site and made available to crawler threads. |
LastActivationTime | Value | The number of seconds since epoch at which this site's URLs were last brought into memory. |
LastActivationDuration | Value | The number of seconds that this site's URLs were last in memory and available to crawler threads. |
IPAddressList | IPAddress | All known IP addresses for this site's server host. |
IPAddress | Value | IPv4 dot-notation address for the site's server host. |
RobotsContent | Text | Text from the robots file, if any text exists. |
HTTPCodeDist | HTTPCode | Distribution of HTTP codes from this site's attempted downloads. |
HTTPCode | Code: Integer An HTTP status code or another internal code. |
How many times a particular HTTP status code occurred during the crawl of this site. |
Detailed status for severs crawled by the Web crawler
When you run the command to obtain detailed crawl space status for the Web crawler, the command returns information in an XML document format. The following information about specific Web servers that are crawled can be returned by the detailed crawl space status command.
<ServerStatus>
<Server Name ="www.example.com">
<Status>1</Status>
<StatusMessage>Running</StatusMessage>
<NumberOfURLs></NumberOfURLs>
<NumberOfCrawledURLs>109771</NumberOfCrawledURLs>
<NumberOfInsertedURLs>1030</NumberOfInsertedURLs>
<NumberOfUpdatedURLs>2053</NumberOfUpdatedURLs>
<NumberOfDeletedURLs>2045</NumberOfDeletedURLs>
<HTTPStatus value=200>100000</HTTPStatus>
<HTTPStatus value=404>2045</HTTPStatus>
…
<StartTime>1100497759852</StartTime>
<EndTime></EndTime>
<TotalTime>1395055</TotalTime>
</Server>
</ServerStatus>
Element | Attributes | Description |
---|---|---|
ServerStatus | Name | The host name of the crawled server. |
Status | The crawler status for this server. Values are 0: Idle; 1: Running; -1: Error. | |
StatusMessage | The string representation of the Status element. Idle: Idle; Running: Running; Error: Error. | |
NumberOfURLs | The number of known URLs for this server. | |
NumberOfCrawledURLs | The number of documents crawled during this session on this server. | |
NumberOfInsertedURLs | The number of documents inserted during this session on this server. | |
NumberOfDeletedURLs | The number of documents deleted during this session on this server. | |
HTTPStatus | Value (HTTP return code) | The number of documents with this HTTP status code. |
StartTime | The time this crawler start crawling this server. | |
EndTime | The time this crawler stopped crawling this server. | |
TotalTime | The total time spent to crawl this server, in milliseconds. |
Non-Web crawler status
FFQC5314I Result: <?xml version='1.0' encoding='UTF-8'?>
<GeneralStatus>
<Status>0</Status>
<StatusMessage>Idle</StatusMessage>
<NumberOfServers>1</NumberOfServers>
<NumberOfCompletedServers>1</NumberOfCompletedServers>
<NumberOfTargets>3</NumberOfTargets>
<NumberOfCompletedTargets>3</NumberOfCompletedTargets>
<NumberOfCrawledRecords>115</NumberOfCrawledRecords>
<RunningThreads>0</RunningThreads>
</GeneralStatus>
Element and attribute name | NNTP crawler | DB2 and JDBC database crawlers | Notes crawler |
---|---|---|---|
Status | Status (0, 1, 2, -1) | Status (0, 1, 2, -1) | Status (0, 1, 2, -1) |
StatusMessage | Status: 0 - Idle, 1 - Running, 2 - Paused, -1 - Error | Status: 0 - Idle, 1 - Running, 2 - Paused, -1 - Error | Status: 0 - Idle, 1 - Running, 2 - Paused, -1 - Error |
NumberOfServers | The number of NNTP servers in the crawl space. | The number of databases in the crawl space. | The number of databases in the crawl space. |
NumberOfCompletedServers | The number of crawled NNTP servers. | The number of crawled databases. | The number of crawled databases. |
NumberOfTargets | The number of news groups in the crawl space. | The number of databases in the crawl space. | The number of views and folders in the crawl space. |
NumberOfCompletedTargets | The number of crawled news groups. | The number of crawled tables. | The number of crawled views and folders. |
NumberOfCompletedRecords | The number of crawled articles. | The number of crawled records. | The number of crawled documents. |
RunningThreads | The number of crawler threads. | The number of crawler threads. | The number of crawler threads. |
Element and attribute name | Exchange Server crawler | Content Manager crawler | Content Integrator crawler |
---|---|---|---|
Status | Status (0, 1, 2, -1) | Status (0, 1, 2, -1) | Status (0, 1, 2, -1) |
StatusMessage | Status: 0 - Idle, 1 - Running, 2 - Paused, -1 - Error | Status: 0 - Idle, 1 - Running, 2 - Paused, -1 - Error | Status: 0 - Idle, 1 - Running, 2 - Paused, -1 - Error |
NumberOfServers | The number of Exchange Server servers in the crawl space. | The number of Content Manager EE servers in the crawl space. | The number of repositories in the crawl space. |
NumberOfCompletedServers | The number of crawled Exchange Server servers. | The number of crawled Content Manager EE servers. | The number of crawled repositories. |
NumberOfTargets | The number of subfolders in the crawl space. | The number of item types in the crawl space. | The number of classes in the crawl space. |
NumberOfCompletedTargets | The number of crawled subfolders. | The number of crawled item types. | The number of crawled item classes. |
NumberOfCompletedRecords | The number of crawled documents. | The number of crawled documents. | The number of crawled documents. |
RunningThreads | The number of crawler threads. | The number of crawler threads. | The number of crawler threads. |
Element and attribute name | Quickr for Domino crawler | UNIX file system and Windows file system crawlers |
---|---|---|
Status | Status (0, 1, 2, -1) | Status (0, 1, 2, -1) |
StatusMessage | Status: 0 - Idle, 1 - Running, 2 - Paused, -1 - Error | Status: 0 - Idle, 1 - Running, 2 - Paused, -1 - Error |
NumberOfServers | The number of places in the crawl space. | Fixed value of 1. |
NumberOfCompletedServers | The number of crawled places. | 0 or 1 if all subdirectories are crawled. |
NumberOfTargets | The number of place databases and room databases in the crawl space. | The number of subdirectories in the crawl space. |
NumberOfCompletedTargets | The number of crawled place databases and room databases. | The number of crawled subdirectories. |
NumberOfCompletedRecords | The number of crawled documents. | The number of crawled files. |
RunningThreads | The number of crawler threads. | The number of crawler threads. |
Element and attribute name | Seed list crawler | SharePoint crawler | FileNet P8 crawler |
---|---|---|---|
Status | Status (0, 1, 2, -1) | Status (0, 1, 2, -1) | Status (0, 1, 2, -1) |
StatusMessage | Status: 0 - Idle, 1 - Running, 2 - Paused, -1 - Error | Status: 0 - Idle, 1 - Running, 2 - Paused, -1 - Error | Status: 0 - Idle, 1 - Running, 2 - Paused, -1 - Error |
NumberOfServers | The number of seed lists in the crawl space (always 1). | The number of SharePoint elements to be crawled. | The number of FileNet® P8 elements (classes or folders) to be crawled. |
NumberOfCompletedServers | The number of crawled seed lists. | The number of crawled elements. | The number of crawled elements. |
NumberOfTargets | The number of seed lists in the crawl space (always 1). | The number of SharePoint elements to be crawled. | The number of FileNet P8 elements (classes or folders) to be crawled. |
NumberOfCompletedTargets | The number of crawled seed lists. | The number of crawled elements. | The number of crawled elements. |
NumberOfCompletedRecords | The number of crawled documents. | The number of crawled documents. | The number of crawled files. |
RunningThreads | The number of crawler threads. | The number of crawler threads. | The number of crawler threads. |
Element and attribute name | BoardReader crawler | Agent for Windows file systems crawler |
---|---|---|
Status | Status (0, 1, 2, -1) | Status (0, 1, 2, -1) |
StatusMessage | Status: 0 - Idle, 1 - Running, 2 - Paused, -1 - Error | Status: 0 - Idle, 1 - Running, 2 - Paused, -1 - Error |
NumberOfServers | The number of target BoardReader sources. | The number of specified directories to be crawled. |
NumberOfCompletedServers | The number of crawled sources. | The number of crawled directories that are explicitly defined in the configuration. |
NumberOfTargets | The number of target BoardReader sources. | The number of specified directories to be crawled. |
NumberOfCompletedTargets | The number of crawled sources. | The number of crawled directories that are explicitly defined in the configuration. |
NumberOfCompletedRecords | The number of crawled documents. | The number of crawled documents. |
RunningThreads | The number of crawler threads. | The number of crawler threads. |
Crawl space status for non-Web crawlers
FFQC5314I Result: <?xml version='1.0' encoding='UTF-8'?>
<ServerStatus>
<Server Name ="FOUNTAIN">
<Status>5</Status>
<StatusMessage>Scheduled</StatusMessage>
<NumberOfTargets>1</NumberOfTargets>
<NumberOfCompletedTargets>1</NumberOfCompletedTargets>
<NumberOfErrors>0</NumberOfErrors>
<StartTime>1118354510512</StartTime>
<EndTime>1118354514386</EndTime>
<ScheduleConfigured>2</ScheduleConfigured>
<ScheduleTime>1118393377000</ScheduleTime>
<TotalTime>3874</TotalTime>
</Server>
</ServerStatus>
server name + database name
. When the aggregation
level is 1, Server@Name is server name + directory name
.
Element and attribute name | NNTP crawler | DB2 and JDBC database crawlers | Notes crawler |
---|---|---|---|
Server@Name | News server name | Database name | Database name or directory name |
Server/Status | Status: (0, 1, 2, 3, 4, 5, -1)
|
Status (0, 1, 2, 3, 4, 5, -1)
|
Status (0, 1, 2, 3, 4, 5, -1)
|
Server/StatusMessage |
|
|
|
Server/NumberOfTargets | The number of news groups in the crawl space. | The number of databases in the crawl space. | The number of views and folders or directories in the crawl space. |
Server/NumberOf CompletedTargets | The number of crawled news groups. | The number of crawled tables. | The number of crawled views and folders or directories. |
Server/NumberOfErrors | The number of errors. | The number of errors. | The number of errors |
Server/StartTime | The start time if applicable. | The start time if applicable. | The start time if applicable. |
Server/EndTime | The end time if applicable. | The end time if applicable. | The end time if applicable. |
Server/ScheduleConfigured | 0, 1, 2
|
0, 1, 2
|
0, 1, 2
|
Server/ScheduleTime | Schedule time if applicable. | Schedule time if applicable. | Schedule time if applicable. |
Server/TotalTime | The total time if applicable. | The total time if applicable. | The total time if applicable. |
Server/AggregationLevel | 0: The crawler crawls documents with normal mode. | 0: The crawler crawls documents with normal mode. | 0, 1:
|
Element and attribute name | Exchange Server crawler | Content Manager crawler | Content Integrator crawler |
---|---|---|---|
Server@Name | Exchange Server server name. | Content Manager EE servers. | Repository name. |
Server/Status | Status (0, 1, 2, 3, 4, 5, -1)
|
Status (0, 1, 2, 3, 4, 5, -1)
|
Status (0, 1, 2, 3, 4, 5, -1)
|
Server/StatusMessage |
|
|
|
Server/NumberOfTargets | The number of subfolders in the crawl space. | The number of item types in the crawl space. | The number of item classes in the crawl space. |
Server/NumberOf CompletedTargets | The number of crawled subfolders. | The number of crawled item types. | The number of crawled item classes. |
Server/NumberOfErrors | The number of errors. | The number of errors. | The number of errors. |
Server/StartTime | The start time if applicable. | The start time if applicable. | The start time if applicable. |
Server/EndTime | The end time if applicable. | The end time if applicable. | The end time if applicable. |
Server/ScheduleConfigured | 0, 1, 2
|
0, 1, 2
|
0, 1, 2
|
Server/ScheduleTime | Schedule time if applicable. | Schedule time if applicable. | Schedule time if applicable. |
Server/TotalTime | The total time if applicable. | The total time if applicable. | The total time if applicable. |
Server/AggregationLevel | 0: The crawler crawls documents with normal mode. | 0: The crawler crawls documents with normal mode. | 0: The crawler crawls documents with normal mode. |
Element and attribute name | Quickr for Domino crawler | UNIX file system and Windows file system crawlers |
---|---|---|
Server@Name | Place directory | A fixed value of localhost. |
Server/Status | Status (0, 1, 2, 3, 4, 5, -1)
|
Status (0, 1, 2, 3, 4, 5, -1)
|
Server/StatusMessage |
|
|
Server/NumberOfTargets | The number of place databases and room databases in the crawl space. | The number of subdirectories in the crawl space. |
Server/NumberOf CompletedTargets | The number of crawled place databases and room databases. | The number of subdirectories in the crawl space. |
Server/NumberOfErrors | The number of errors. | The number of errors. |
Server/StartTime | The start time if applicable. | The start time if applicable. |
Server/EndTime | The end time if applicable. | The end time if applicable. |
Server/ScheduleConfigured | 0, 1, 2
|
0, 1, 2
|
Server/ScheduleTime | Schedule time if applicable. | Schedule time if applicable. |
Server/TotalTime | The total time if applicable. | The total time if applicable. |
Server/AggregationLevel | 0: The crawler crawls documents with normal mode. | 0: The crawler crawls documents with normal mode. |
Element and attribute name | Seed list crawler | SharePoint crawler | FileNet P8 crawler |
---|---|---|---|
Server@Name | Seed list server name | Library database | A fixed value of localhost. |
Server@SpaceId | N/A | Crawl space internal ID. | Crawl space internal ID. |
Server@SpaceLabel | N/A | SharePoint element full name. | FileNet P8 element full name. |
Server/Status | Status (0, 1, 2, 3, 4, 5, -1)
|
Status (0, 1, 2, 3, 4, 5, -1)
|
Status (0, 1, 2, 3, 4, 5, -1)
|
Server/StatusMessage |
|
|
|
Server/NumberOfTargets | The number of seed lists in the crawl space (always 1). | The number of SharePoint elements to be crawled. | The number of FileNet P8 elements to be crawled. |
Server/NumberOf CompletedTargets | The number of crawled seed lists. | The number of crawled elements. | The number of crawled elements. |
Server/NumberOfErrors | The number of errors. | The number of errors. | The number of errors. |
Server/StartTime | The start time if applicable. | The start time if applicable. | The start time if applicable. |
Server/EndTime | The end time if applicable. | The end time if applicable. | The end time if applicable. |
Server/ScheduleConfigured | 0, 1, 2
|
0, 1, 2
|
0, 1, 2
|
Server/ScheduleTime | Schedule time if applicable. | Schedule time if applicable. | Schedule time if applicable. |
Server/TotalTime | The total time if applicable. | The total time if applicable. | The total time if applicable. |
Server/AggregationLevel | 0: The crawler crawls documents with normal mode. | 0: The crawler crawls documents with normal mode. | 0: The crawler crawls documents with normal mode. |
Element and attribute name | BoardReader crawler | Agent for Windows file systems crawler |
---|---|---|
Server@Name | Target source name. | Directory name. |
Server@SpaceId | Crawl space internal ID. | Crawl space internal ID. |
Server@SpaceLabel | Target source full name. | Directory full name. |
Server/Status | Status (0, 1, 2, 3, 4, 5, -1)
|
Status (0, 1, 2, 3, 4, 5, -1)
|
Server/StatusMessage |
|
|
Server/NumberOfTargets | The number of BoardReader target sources. | The number of specified directories to be crawled. |
Server/NumberOf CompletedTargets | The number of crawled sources. | The number of crawled directories that are explicitly defined in the configuration. |
Server/NumberOfErrors | The number of errors. | The number of errors. |
Server/StartTime | The start time if applicable. | The start time if applicable. |
Server/EndTime | The end time if applicable. | The end time if applicable. |
Server/ScheduleConfigured | 0, 1, 2
|
0, 1, 2
|
Server/ScheduleTime | Schedule time if applicable. | Schedule time if applicable. |
Server/TotalTime | The total time if applicable. | The total time if applicable. |
Server/AggregationLevel | 0: The crawler crawls documents with normal mode. | 0: The crawler crawls documents with normal mode. |
Detailed crawl space status for non-Web crawlers
FFQC5314I Result: <?xml version='1.0' encoding='UTF-8'?>
<TargetStatus>
<Target Name ="escmgr.crawlerinstances">
<Status>2</Status>
<StatusMessage>Completed</StatusMessage>
<NumberOfRecords></NumberOfRecords>
<NumberOfCrawledRecords>117</NumberOfCrawledRecords>
<NumberOfInsertedRecords>21</NumberOfInsertedRecords>
<NumberOfUpdatedRecords>45</NumberOfUpdatedRecords>
<StartTime>1118354510727</StartTime>
<EndTime>1118354514386</EndTime>
<AggregationLevel>0<AggregationLevel>
<Target>
</TargetStatus>
Element and attribute name | NNTP crawler | DB2 and JDBC database crawlers | Notes crawler |
---|---|---|---|
Target@Name | News group name | Table name | View or folder name |
Target@CrawlType | Not applicable. | 0,1 (DB2); 0 (JDBC database)
|
0 |
Target/Status | Status: (0, 1, 2, 3, 4, -1)
|
Status: (0, 1, 2, 3, 4, -1)
|
Status: (0, 1, 2, 3, 4, -1)
|
Target/StatusMessage |
|
|
|
Target/NumberOf Records | The last article number on the server. | The number of crawled records. | The number of crawled documents. |
Target/NumberOf CompletedRecords | The number of crawled articles. | The number of crawled records. | The number of crawled documents. |
Target/NumberOf InsertedRecords | The number of newly posted articles. | The number of inserted records. | The number of inserted records. |
Target/NumberOf UpdatedRecords | Not applicable. | The number of updated records. | The number of updated records. |
Target/NumberOf DeletedRecords | Not applicable. | The number of deleted records. | The number of deleted records. |
Target/StartTime | The date and time that the crawler last started. | The date and time that the crawler last started. | The date and time that the crawler last started. |
Target/EndTime | The date and time that crawling was completed. | The date and time that crawling was completed. | The date and time that crawling was completed. |
Target/TotalTime | The amount of time that the crawler spent crawling. | The amount of time that the crawler spent crawling. | The amount of time that the crawler spent crawling. |
Target/AggregationLevel | 0: The crawler crawls documents with normal mode. | 0: The crawler crawls documents with normal mode. | 0, 1:
|
Target/LastUpdatedTime | Not applicable. | The last updated time:
|
Not applicable. |
Target/LastResetTime | Not applicable. | The last time reset statistics:
|
Not applicable. |
Element and attribute name | Exchange Server crawler | Content Manager crawler | Content Integrator crawler |
---|---|---|---|
Target@Name | Subfolder name | Item type name | Item class name |
Target@CrawlType | 0 | 0 | 0 |
Target/Status | Status (0, 1, 2, 3, 4, -1)
|
Status (0, 1, 2, 3, 4, -1)
|
Status (0, 1, 2, 3, 4, -1)
|
Target/StatusMessage |
|
|
|
Target/NumberOf Records | Not applicable. | Not applicable. | Not applicable. |
Target/NumberOf CompletedRecords | The number of crawled documents. | The number of crawled documents. | The number of crawled documents. |
Target/NumberOf InsertedRecords | The number of inserted records. | The number of inserted records. | The number of inserted records. |
Target/NumberOf UpdatedRecords | Not applicable. | The number of updated records. | The number of updated records. |
Target/NumberOf DeletedRecords | Not applicable. | The number of deleted records. | The number of deleted records. |
Target/StartTime | The date and time that the crawler last started. | The date and time that the crawler last started. | The date and time that the crawler last started. |
Target/EndTime | The date and time that crawling was completed. | The date and time that crawling was completed. | The date and time that crawling was completed. |
Target/TotalTime | The amount of time that the crawler spent crawling. | The amount of time that the crawler spent crawling. | The amount of time that the crawler spent crawling. |
Target/AggregationLevel | 0: The crawler crawls documents with normal mode. | 0: The crawler crawls documents with normal mode. | 0: The crawler crawls documents with normal mode. |
Target/LastUpdatedTime | Not applicable. | Not applicable. | Not applicable. |
Target/LastResetTime | Not applicable. | Not applicable. | Not applicable. |
Element and attribute name | Quickr for Domino crawler | UNIX file system and Windows file system crawlers |
---|---|---|
Target@Name | PPlace database name or room database name | Subdirectory name |
Target@CrawlType | 0 | 0 |
Target/Status | Status (0, 1, 2, 3, 4, -1)
|
Status (0, 1, 2, 3, 4, -1)
|
Target/StatusMessage |
|
|
Target/NumberOf Records | Not applicable. | Not applicable. |
Target/NumberOf CompletedRecords | The number of crawled documents. | The number of crawled files. |
Target/NumberOf InsertedRecords | The number of inserted records. | The number of inserted records. |
Target/NumberOf UpdatedRecords | The number of updated records. | The number of updated records. |
Target/NumberOf DeletedRecords | The number of deleted records. | The number of deleted records. |
Target/StartTime | The date and time that the crawler last started. | The date and time that the crawler last started. |
Target/EndTime | The date and time that crawling was completed. | The date and time that crawling was completed. |
Target/TotalTime | The amount of time that the crawler spent crawling. | The amount of time that the crawler spent crawling. |
Target/AggregationLevel | 0: The crawler crawls documents with normal mode. | 0: The crawler crawls documents with normal mode. |
Target/LastUpdatedTime | Not applicable. | Not applicable. |
Target/LastResetTime | Not applicable. | Not applicable. |
Element and attribute name | Seed list crawler | SharePoint crawler | FileNet P8 crawler |
---|---|---|---|
Target@Name | Seed list server address | Item type name | Item class name |
Target@SpaceId | N/A | Crawl space internal ID | Crawl space internal ID |
Target@SpaceLabel | N/A | SharePoint element full name | FileNet P8 element full name |
Target@CrawlType | 0 | 0 | 0 |
Target/Status | Status (0, 1, 2, 3, 4, -1)
|
Status (0, 1, 2, 3, 4, -1)
|
Status (0, 1, 2, 3, 4, -1)
|
Target/StatusMessage |
|
|
|
Target/NumberOf Records | Not applicable. | Not applicable. | Not applicable. |
Target/NumberOf CompletedRecords | The number of crawled records. | The number of crawled documents. | The number of crawled documents. |
Target/NumberOf InsertedRecords | The number of inserted records. | The number of inserted records. | The number of inserted records. |
Target/NumberOf UpdatedRecords | The number of updated records. | The number of updated records. | The number of updated records. |
Target/NumberOf DeletedRecords | The number of deleted records. | The number of deleted records. | The number of deleted records. |
Target/StartTime | The date and time that the crawler last started. | The date and time that the crawler last started. | The date and time that the crawler last started. |
Target/EndTime | The date and time that crawling was completed. | The date and time that crawling was completed. | The date and time that crawling was completed. |
Target/TotalTime | The amount of time that the crawler spent crawling. | The amount of time that the crawler spent crawling. | The amount of time that the crawler spent crawling. |
Target/AggregationLevel | 0: The crawler crawls documents with normal mode. | 0: The crawler crawls documents with normal mode. | 0: The crawler crawls documents with normal mode. |
Target/LastUpdatedTime | Not applicable. | Not applicable. | Not applicable. |
Target/LastResetTime | Not applicable. | Not applicable. | Not applicable. |
Element and attribute name | BoardReader crawler | Agent for Windows file systems crawler |
---|---|---|
Target@Name | Target source name | Directory name |
Target@SpaceId | Crawl space internal ID | Crawl space internal ID |
Target@SpaceLabel | Target source full name | Directory full name |
Target@CrawlType | 0 | 0 |
Target/Status | Status: (0, 1, 2, 3, 4, -1)
|
Status: (0, 1, 2, 3, 4, -1)
|
Target/StatusMessage |
|
|
Target/NumberOf Records | Not applicable. | Not applicable. |
Target/NumberOf CompletedRecords | The total number of crawled records. | The total number of crawled records. |
Target/NumberOf InsertedRecords | The number of inserted records. | The number of inserted records. |
Target/NumberOf UpdatedRecords | The number of updated records. | The number of updated records. |
Target/NumberOf DeletedRecords | The number of deleted records. | The number of deleted records. |
Target/StartTime | The date and time that the crawler last started. | The date and time that the crawler last started. |
Target/EndTime | The date and time that crawling was completed. | The date and time that crawling was completed. |
Target/TotalTime | The amount of time that the crawler spent crawling. | The amount of time that the crawler spent crawling. |
Target/AggregationLevel | 0: The crawler crawls documents with normal mode. | 0: The crawler crawls documents with normal mode. |
Target/LastUpdatedTime | Not applicable. | Not applicable. |
Target/LastResetTime | Not applicable. | Not applicable. |
Parser status
FFQC5314I The following result occurred:
<Monitor Type="Parser">
<ParserStatus>
<Status>1</Status>
</ParserStatus>
</Monitor>
Element | Description |
---|---|
Status |
|
Search server status
FFQC5314I Result: <?xml version="1.0"?>
<Monitor Type="Search" Count="1">
<SearchStatus Name="Search Manager (node1)" SearchID=
"searchmanager.node1" HostName="myComputer.svl.ibm.com">
<Status>1</Status>
</SearchStatus>
</Monitor>
Element | Description |
---|---|
SearchStatusName | The name and ID of the search manager session that is monitoring and maintaining the search index for this collection. |
HostName | The host name of the server where the search index is running. |
Status |
|
FFQC5303I Search Manager (node1) (sid: searchmanager.node1)
is already running. PID: 15711
FFQC5314I Result: PID=18390
CacheHits=3
QueryRate=1
Port=44008
SessionId=col1.runtime.node1
CacheHitRate=0.333
ResponseTime=70
Status=1
SessionName=col1.runtime.node1.1
Item | Description |
---|---|
CacheHits | The number of results retrieved from the search cache. |
QueryRate | The number of queries received in the last time interval. By default, the time interval is five minutes. |
Port | The port number that is used by the search index to listen or receive queries. |
SessionId | The session ID for this collection's search index. |
CacheHitRate | The number of results retrieved from the search cache as a percentage of all search results. |
ResponseTime | The average response time in milliseconds for the specified time interval. (The default is five minutes.) |
Status |
|
SessionName | The session name for this collection's search index. |
Return codes for esadmin commands
Code | Name | Description |
---|---|---|
0 | CODE_ERROR_NONE | The command completed successfully. |
102 | CODE_ERROR_INSTANTIATION_EXCEPTION | An error occurred when instantiating a command handler. |
103 | CODE_ERROR_ACCESS_EXCEPTION | An illegal access error occurred when instantiating a command handler. |
104 | CODE_ERROR_EXECUTE_EXCEPTION | |
105 | CODE_ERROR_THROWABLE | |
106 | CODE_ERROR_NO_SUCH_METHOD | |
107 | CODE_ERROR_INVALID_SESSION | |
108 | CODE_ERROR_INVALID_PARAMETER | |
109 | CODE_ERROR_SESSION_NOT_RUNNING |
Obtaining sessions IDs
esadmin
check
command to show a list of components and their corresponding
session IDs. The following table shows a list of common sessions,
their IDs, the server that they are on, and the state of the session.
Session | Server where the session is running | Session ID | Session state |
---|---|---|---|
configmanager | master server | 10433 | Started |
controller | master server | 10464 | Started |
customcommunication | master server | Not applicable | Not applicable |
discovery | master server | 10649 | Started |
monitor | master server | 10682 | Started |
parserservice | master server | 10718 | Started |
resource.node1 | master server | 10759 | Started |
samplecpp | master server | 10827 | Started |
sampletest | master server | 10857 | Started |
scheduler | master server | 10889 | Started |
searchmanager.node1 | master server | 10927 | Started |
utilities.node1 | master server | 10384 | Started |