Export (0) Print
Expand All

waadmin.exe reference

FAST Search Server 2010
 

Applies to: FAST Search Server 2010

Topic Last Modified: 2011-01-24

Use the waadmin tool to configure the WebAnalyzer and to retrieve status information. This command-line tool also lets you manage the WebAnalyzer's schedule for running hyperlink analysis. This tool is rarely needed. You will typically use it to check the WebAnalyzer status with the show commands.

noteNote
To use a command-line tool, verify that you meet the following minimum requirements: You are a member of the FASTSearchAdministrators local group on the computer where FAST Search Server 2010 for SharePoint is installed.

<FASTSearchFolder>\bin\waadmin [global options] <command> [command options]

 

Parameter Description

<FASTSearchFolder>

The path of the folder where you have installed FAST Search Server 2010 for SharePoint, for example C:\FASTSearch.

 

Option Description

-h

Displays help.

-v

Displays version information.

 

Option Description

-c

Specifies a given collection.

-n

Specifies a given view.

-d

Provides a new description for a given view.

-k

Specifies which configuration parameter to change when altering configurations.

-u

Provides a new value for the parameter specified by -k.

-l

Specifies a new verbosity level for the WebAnalyzer.

-q

Provides a URI for the ShowURIRelevance command.

-f

When using ShowURIRelevance, specifies the maximum number of anchor texts included in the result. Default: 10

-b

Specifies a backup file name for the BackupConfig and RestoreConfig commands.

 

Command Required options Optional options Description

AbortProcessing

None

-n <viewname>

Stops processing on the default view, or the view provided with -n.

If the view is not being processed, it will be set directly in stopped state. If it is running, link data will be persisted but you must restart processing on the view.

EnqueueView

None

-n <viewname>

Sets a view into a scheduled state.

When a collection that is part of the view receives new content, the view is moved into the end of the processing queue. If no view name is provided, the default view is used.

DequeueView

None

-n <viewname>

Removes a view from the processing queue.

Views are typically re-enqueued as soon as they come out of the processing pipeline, but DequeueView discontinues this cycle for the specified view. A view can be added later with EnqueueView. If the view is being processed, it will complete its run first.

If no view name is provided, the default view is used.

ExpediteProcessing

None

-n <viewname>

Puts a view first in the view processing queue, even if the view is already in the queue.

ForceProcessing

None

-n <viewname>

Pauses any ongoing processing and starts to process the specified view, if the view has at least one member collection.

After link processing, the paused view (if any) will resume processing.

Alternative use: To analyze a view that has no new data. ForceProcessing will run link processing again on the existing data even if the link data has not changed since the last link processing.

noteNote
The paused view must first persist its files, which may take some time.

ProcessOnce

None

-n <viewname>

ProcessOnce resembles ForceProcessing except that after the view is processed, it is not re-inserted into the queue.

After processing has finished on the specified view, the paused view (if any) resumes processing.

Alternative use: To analyze a view that has no new data. ProcessOnce will run link processing again on the existing data even if the link data has not changed since the last link processing.

noteNote
The paused view must first persist its files, which may take some time.

PauseProcessing

None

None

Pauses ongoing processing on the current view. All link data will be persisted and processing can be resumed later.

noteNote
The paused view must first persist its files, which may take some time.

 

Command Required options Optional options Description

AlterViewDescription

-d <description>

-n <viewname>

Changes the description of the view.

CreateView

-n <viewname>

-d <description>

Creates a new view.

DeleteView

-n <viewname>

None

Deletes a view. The default view cannot be deleted.

 

Command Required options Optional options Description

UnsetPreferredView

-c <collection name>

None

Assigns the default WebAnalyzer view to the crawl collection as a source of relevance data.

SetPreferredView

-c <collection name>

-n <viewname>

Assigns a WebAnalyzer view to a crawl collection for getting relevance data.

AddCollections

-c <collection name>

-n <viewname>

Adds crawl collections to a view. The view gets hyperlinks from these crawl collections. Separate multiple collections with a comma.

RemoveCollections

-c <collection name>

-n <viewname>

Removes collections from a view. Separate multiple collections with a comma.

 

Command Required options Optional options Description

SetFDMConfig

-k <keyword>

-u <value>

None

Advanced option: Changes the processing configuration (FDM is a framework used to generate the analysis).

SetConfig

-k <keyword>

-u <value>

None

Changes the runtime configuration of WebAnalyzer.

SetViewConfig

-k <keyword>

-u <value>

-n <viewname>

Changes configuration parameters for the specified view.

SetLogLevel

-l <log level>

None

Sets the verbosity level of the WebAnalyzer log to one of five levels: error, warning, info, verbose, debug.

 

Command Required options Optional options Description

ShowConfig

None

None

Displays the current runtime configuration of the WebAnalyzer.

ShowFDMConfig

None

None

Displays the current runtime configuration of FDM (Fast Distributed Make, a framework used to generate the analysis).

ShowStatus

None

None

Displays the WebAnalyzer's status.

ShowLogLevel

None

None

Displays the WebAnalyzer's current log verbosity setting.

ShowAllViews

None

None

Displays status for all views.

ShowAllPreferred

None

None

Displays the Lookup view for all collections.

ShowViewConfig

None

-n <viewname>

Shows the current configuration for the specified view.

ShowViewStatus

None

-n <viewname>

Displays the current status for a specified view.

ShowURIRelevance

-q <URI>

-n <viewname>

-f <max_anchortexts>

Queries the WebAnalyzer lookup databases.

A query returns the docrank, siterank, and anchortexts (up to the number that is specified by the -f option) of a specified URI.

 

Command Required options Optional options Description

BackupConfig

-b <filename>

None

Backs up the WebAnalyzer configuration.

RestoreConfig

-b <filename>

None

Restores the WebAnalyzer configuration from a file that is created by BackupConfig.

ExtendedHelp

(any command name, e.g. ‘ExtendedHelp ShowURIRelevance’)

Displays extended help for the specified options.

 

Keyword (Parameter) Value Description

batch_size

<value>

The maximum number of items in a batch.

Default: 128

callback_timeout

<value>

The time (in seconds) to wait for callback after the last batch is submitted.

Default: 1800

concurrent_feeds

<value>

Specifies how many feeding clients can run at the same time. This value is the total number of clients on all nodes in the installation.

Default: 4

cpus

A value equal to the "max-targets" value specified during installation

Specifies how many processes can be run at the same time. If this value times the number of nodes in the system is lower than the concurrent_feeds value, this value specifies the number of feeding clients.

pollwalsr_callback_interval

<value>

The interval (in seconds) between the times that the WebAnalyzer checks for new link data.

Default: 300

 

Keyword (Parameter) Value Description

disk_free

<value>

Minimum amount of free disk space (in MB) that must be available on a node for link processing. If free disk space goes below this limit, the node will not be used for link processing.

Default: 2000

verbose

true|false

Verbosity of the link analysis.

Default: false

 

Keyword (Parameter) Value Description

drop_intra

true|false

Specifies if intra-site links are discarded from the analysis.

If false, all links are included in the analysis.

If true, only links going between items on different sites are included in the analysis.

Default: false

force_collections

true|false

Specifies if the WebAnalyzer should attempt to update all crawl collections in the view, even if the crawl collections have not received new content.

If false, the WebAnalyzer will only update crawl collections that it knows have received new . But it will still add all crawl collections in the view to the analysis.

Default: false

run_partial_update

true|false

Specifies if the WebAnalyzer should update the index with new relevance data after it completes an analysis run.

If false, the WebAnalyzer will not update the index, and the updates will not be stored and applied later.

Default: true

sort_buffer

<value>

The amount of memory (in megabytes) to use when sorting data. This value is specified per task running in the system.

Default: 200

The following example forces the WebAnalyzer to process the default WebAnalyzer view immediately, if it is not running:

<FASTSearchFolder>\bin\waadmin forceprocessing

The following example creates a new WebAnalyzer view called view1:

<FASTSearchFolder>\bin\waadmin createview -n view1

The following example configures view1 to use links from crawl collections sp and intrasitecoll:

<FASTSearchFolder>\bin\waadmin addcollections -nview1 -c"sp,intrasitecoll"

or

<FASTSearchFolder>\bin\waadmin addcollections -nview1 -csp

<FASTSearchFolder>\bin\waadmin addcollections -nview1 -cintrasitecoll

The following example shows the status for view1:

<FASTSearchFolder>\bin\waadmin showviewstatus -nview1

The following example configures view1 to run when crawl collection sp gets new content:

<FASTSearchFolder>\bin\waadmin enqueueview -nview1

The following example shows relevance data for an item with the item id <URL>, assuming that it is in the lookup databases for the default WebAnalyzer view:

<FASTSearchFolder>\bin\waadmin -q <URL> -f 5 ShowURIRelevance

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft