Chapter 12 Search Subcommands - Robot Administration and Autoclassify

This chapter describes the following commands:

• psadmin get-robot-status

• psadmin start-robot

• psadmin stop-robot

• psadmin create-robot-site

• psadmin delete-robot-site

• psadmin list-robot-sites

• psadmin enable-robot-sites

• psadmin disable-robot-sites

• psadmin list-robot-converters

• psadmin enable-robot-converters

• psadmin disable-robot-converters

• psadmin run-robot-simulator

• psadmin run-robot-siteprobe

• psadmin run-search-autoclassify

psadmin get-robot-status

Description

Displays the search robot status.

Syntax

Long Format

psadmin get-robot-status --searchserver search-server-ID --adminuser uid --passwordfile password-filename

Short Format

psadmin get-robot-status -s search-server-ID -u uid -f password-filename

Options

The following options are required:

[--adminuser | -u] uid

Specifies the Administrator's ID.

[--passwordfile | -f] password-filename

Specifies the name of the password file.

[--searchserver | -s] search-server-ID

Specifies the search server ID.

The following options are optional:

[--debug]

Specifies if debug mode is turned on.

[--output] output-filename

Specifies if the output mode is used.

[--verbose | -v]

Specifies if the verbose mode is used.

psadmin start-robot

Description

Starts the search robot.

Syntax

Long Format

psadmin start-robot --searchserver search-server-ID --adminuser uid --passwordfile password-filename

Short Format

psadmin start-robot -s search-server-ID -u uid -f password-filename

Options

The following options are required:

[--adminuser | -u] uid

Specifies the Administrator's ID.

[--passwordfile | -f] password-filename

Specifies the name of the password file.

[--searchserver | -s] search-server-ID

Specifies the search server ID.

The following options are optional:

[--debug]

Specifies if debug mode is turned on.

[--output] output-filename

Specifies if the output mode is used.

[--verbose | -v]

Specifies if the verbose mode is used.

psadmin stop-robot

Description

Stops the search robot.

Syntax

Long Format

psadmin stop-robot --searchserver search-server-ID --adminuser uid --passwordfile password-filename

Short Format

psadmin stop-robot -s search-server-ID -u uid -f password-filename

Options

The following options are required:

[--adminuser | -u] uid

Specifies the Administrator's ID.

[--passwordfile | -f] password-filename

Specifies the name of the password file.

[--searchserver | -s] search-server-ID

Specifies the search server ID.

The following options are optional:

[--debug]

Specifies if debug mode is turned on.

[--output] output-filename

Specifies if the output mode is used.

[--verbose | -v]

Specifies if the verbose mode is used.

psadmin create-robot-site

Description

Creates a search robot crawling site.

Syntax

Long Format

psadmin create-robot-site --searchserver search-server-ID --adminuser uid --passwordfile password-filename --sitename site-name [--isdomain] [--depth]

Short Format

psadmin create-robot-site -s search-server-ID -u uid -f password-filename --sitename site-name [--isdomain] [--depth]

Options

The following options are required:

[--adminuser | -u] uid

Specifies the Administrator's ID.

[--passwordfile | -f] password-filename

Specifies the name of the password file.

[--searchserver | -s] search-server-ID

Specifies the search server ID.

[--sitename] site-name

Specifies the site name for the robot to crawl. For example www.siroe.com.

The following options are optional:

[--isdomain]

Specifies if the site is a domain.

[--depth]

Specifies the link depth to be crawled.

[--debug]

Specifies if debug mode is turned on.

[--output] output-filename

Specifies if the output mode is used.

[--verbose | -v]

Specifies if the verbose mode is used.

psadmin delete-robot-site

Description

Deletes a search robot crawling site.

Syntax

Long Format

psadmin delete-robot-site --searchserver search-server-ID --adminuser uid --passwordfile password-filename --site site-ID

Short Format

psadmin delete-robot-site -s search-server-ID -u uid -f password-filename --site site-ID

Options

The following options are required:

[--adminuser | -u] uid

Specifies the Administrator's ID.

[--passwordfile | -f] password-filename

Specifies the name of the password file.

[--searchserver | -s] search-server-ID

Specifies the search server ID.

[--site] site-ID

Specifies the robot site ID. Use the list-robot-sites subcommand to find the site ID.

The following options are optional:

[--debug]

Specifies if debug mode is turned on.

[--output] output-filename

Specifies if the output mode is used.

[--verbose | -v]

Specifies if the verbose mode is used.

psadmin list-robot-sites

Description

Lists the search robot crawling sites.

Syntax

Long Format

psadmin list-robot-sites --searchserver search-server-ID --adminuser uid --passwordfile password-filename [--site] site-ID

Short Format

psadmin list-robot-sites -s search-server-ID -u uid -f password-filename [--site] site-ID

Options

The following options are required:

[--adminuser | -u] uid

Specifies the Administrator's ID.

[--passwordfile | -f] password-filename

Specifies the name of the password file.

[--searchserver | -s] search-server-ID

Specifies the search server ID.

The following options are optional:

[--site] site-ID

Specifies the robot site ID to be displayed. If not specified, all robot sites are displayed.

[--debug]

Specifies if debug mode is turned on.

[--output] output-filename

Specifies if the output mode is used.

[--verbose | -v]

Specifies if the verbose mode is used.

psadmin enable-robot-sites

Description

Enables a search robot crawling site.

Syntax

Long Format

psadmin enable-robot-sites --searchserver search-server-ID --adminuser uid --passwordfile password-filename --sites '"Site1" "Site2" "..." "Site-n"'

Short Format

psadmin enable-robot-sites -s search-server-ID -u uid -f password-filename --sites '"Site1" "Site2" "..." "Site-n"'

Options

The following options are required:

[--adminuser | -u] uid

Specifies the Administrator's ID.

[--passwordfile | -f] password-filename

Specifies the name of the password file.

[--searchserver | -s] search-server-ID

Specifies the search server ID.

[--sites] '"Site1" "Site2" "..." "Site-n"'

Specifies the robot site IDs. Use list-robot-site to find the site ID.

The following options are optional:

[--debug]

Specifies if debug mode is turned on.

[--output] output-filename

Specifies if the output mode is used.

[--verbose | -v]

Specifies if the verbose mode is used.

psadmin disable-robot-sites

Description

Enables a search robot crawling site.

Syntax

Long Format

psadmin disable-robot-sites --searchserver search-server-IDs --adminuser uid --passwordfile password-filename --site '"Site1" "Site2" "..." "Site-n"'

Short Format

psadmin disable-robot-sites -s search-server-ID -u uid -f password-filename --sites '"Site1" "Site2" "..." "Site-n"'

Options

The following options are required:

[--adminuser | -u] uid

Specifies the Administrator's ID.

[--passwordfile | -f] password-filename

Specifies the name of the password file.

[--searchserver | -s] search-server-ID

Specifies the search server ID.

[--sites] '"Site1" "Site2" "..." "Site-n"'

Specifies the robot site IDs. Use list-robot-site to find the site ID.

The following options are optional:

[--debug]

Specifies if debug mode is turned on.

[--output] output-filename

Specifies if the output mode is used.

[--verbose | -v]

Specifies if the verbose mode is used.

psadmin list-robot-converters

Description

Lists all robot document converters for a search server.

Syntax

Long Format

psadmin list-robot-converters --searchserver search-server-ID --adminuser uid --passwordfile password-filename

Short Format

psadmin list-robot-converters -s search-server-ID -u uid -f password-filename

Options

The following options are required:

[--adminuser | -u] uid

Specifies the Administrator's ID.

[--passwordfile | -f] password-filename

Specifies the name of the password file.

[--searchserver | -s] search-server-ID

Specifies the search server ID.

The following options are optional:

[--debug]

Specifies if debug mode is turned on.

[--output] output-filename

Specifies if the output mode is used.

[--verbose | -v]

Specifies if the verbose mode is used.

psadmin enable-robot-converters

Description

Enables a search robot document converter.

Syntax

Long Format

psadmin enable-robot-converters --searchserver search-server-ID --adminuser uid --passwordfile password-filename --converters '"Converter1" "Converter2" "..." "Converter-n"'

Short Format

psadmin enable-robot-converters -s search-server-ID -u uid -f password-filename --converters '"Converter1" "Converter2" "..." "Converter-n"'

Options

The following options are required:

[--adminuser | -u] uid

Specifies the Administrator's ID.

[--passwordfile | -f] password-filename

Specifies the name of the password file.

[--searchserver | -s] search-server-ID

Specifies the search server ID.

[--converters] '"Converter1" "Converter2" "..." "Converter-n"'

Specifies the converter IDs. Use the list-robot-converters subcommand to find the converter ID.

The following options are optional:

[--debug]

Specifies if debug mode is turned on.

[--output] output-filename

Specifies if the output mode is used.

[--verbose | -v]

Specifies if the verbose mode is used.

psadmin disable-robot-converters

Description

Disables a search robot document converter.

Syntax

Long Format

psadmin disable-robot-converters --searchserver search-server-ID --adminuser uid --passwordfile password-filename --converters '"Converter1" "Converter2" "..." "Converter-n"'

Short Format

psadmin disable-robot-converters -s search-server-ID -u uid -f password-filename --converters '"Converter1" "Converter2" "..." "Converter-n"'

Options

The following options are required:

[--adminuser | -u] uid

Specifies the Administrator's ID.

[--passwordfile | -f] password-filename

Specifies the name of the password file.

[--searchserver | -s] search-server-ID

Specifies the search server ID.

[--converters] '"Converter1" "Converter2" "..." "Converter-n"'

Specifies the converter IDs. Use the list-robot-converter subcommand to find the ID.

The following options are optional:

[--debug]

Specifies if debug mode is turned on.

[--output] output-filename

Specifies if the output mode is used.

[--verbose | -v]

Specifies if the verbose mode is used.

psadmin run-robot-simulator

Description

Runs the robot simulator in the search server.

Syntax

Long Format

psadmin run-robot-simulator --searchserver search-server-ID --adminuser uid --passwordfile password-filename [--sitename site-name] [--nodns] [--noredirect]

Short Format

psadmin run-robot-simulator -s search-server-ID -u uid -f password-filename [--sitename site-name] [--nodns] [--noredirect]

Options

The following options are required:

[--adminuser | -u] uid

Specifies the Administrator's ID.

[--passwordfile | -f] password-filename

Specifies the name of the password file.

[--searchserver | -s] search-server-ID

Specifies the search server ID.

The following options are optional:

[--sitename] site-name

Specifies the robot site for running robot simulator, for example, www.siroe.com. If this is not specified, the simulator runs against all robot sites that are not a domain .

[--nodns]

Specifies not to check for DNS aliases when running the robot simulator.

[--noredirect]

Specifies not to check for server redirect when running the robot simulator.

[--debug]

Specifies if debug mode is turned on.

[--output] output-filename

Specifies if the output mode is used.

[--verbose | -v]

Specifies if the verbose mode is used.

psadmin run-robot-siteprobe

Description

Runs the robot simulator in a search server.

Syntax

Long Format

psadmin run-robot-siteprobe --searchserver search-server-ID --adminuser uid --passwordfile password-filename --sitename site-name [--nodns]

Short Format

psadmin run-robot-siteprobe -s search-server-ID -u uid -f password-filename --sitename site-name [--nodns]

Options

The following options are required:

[--adminuser | -u] uid

Specifies the Administrator's ID.

[--passwordfile | -f] password-filename

Specifies the name of the password file.

[--searchserver | -s] search-server-ID

Specifies the search server ID.

[--sitename] siteName

Specifies the robot site for running robot simulator. For example, www.siroe.com.

The following option is optional:

[--nodns]

Specifies not to check for DNS aliases when running the robot simulator.

[--debug]

Specifies if debug mode is turned on.

[--output] output-filename

Specifies if the output mode is used.

[--verbose | -v]

Specifies if the verbose mode is used.

psadmin run-search-autoclassify

Description

Runs autoclassify in a search server.

Syntax

Long Format

psadmin run-search-autoclassify --searchserver search-server-ID --adminuser uid --passwordfile password-filename --database database-name

Short Format

psadmin run-search-autoclassify -s search-server-ID -u uid -f password-filename --database database-name

Options

The following options are required:

[--adminuser | -u] uid

Specifies the Administrator's ID.

[--passwordfile | -f] password-filename

Specifies the name of the password file.

[--searchserver | -s] search-server-ID

Specifies the search server ID.

[--database] database-name

Specifies the database name against which to run autoclassify.

The following options are optional:

[--debug]

Specifies if debug mode is turned on.

[--output] output-filename

Specifies if the output mode is used.

[--verbose | -v]

Specifies if the verbose mode is used.