Sun Java System Portal Server 7 Command-Line Reference

Chapter 11 Search Subcommands - Resource Description

This chapter describes the following subcommands:

psadmin list-search-resourcedescriptions

Description

Lists the resource descriptions from a search server.

Syntax

Long Format

psadmin list-search-resourcedescriptions --searchserver search-server-ID --searchtype search-type --adminuser uid --passwordfile password-filename --database database-name [--debug] [--output output-filename] [--verbose] [--query query] [--viewattributes '"view1" "view2" "..." "viewN"'] [--startpage start-page] [--hitsperpage hits-per-page]

Short Format

psadmin list-search-rds -s search-server-ID --searchtype search-type -u uid -f password-filename --database database-name [--debug] [--output output-filename] [-v] [--query query] [--viewattributes '"view1" "view2" "..." "viewN"'] [--startpage start-page] [--hitsperpage hits-per-page]

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.

[--searchtype] search-type

Specifies the type of search. The values are all, uncategorized, categorized, by_category, by_url, by_query.

[--database] database-name

Specifies the name of the database.

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.

[--query] query

Specifies the search query. The values are by_category, by_url andby_query.

[--veiwattributes] '"view1" "view2" "..." "viewN"'

Displays the list of view attributes. To pass a list of strings, use the format '” string1” “string2” “...” “stringN”'.

[--startpage] start-page

Specifies pagination. The startpage option is used with hitsperpage to manage how the results are displayed. The startpage option determines the page for a grouping of results, and hitsperpage determines how many results are in one group. The startpage value can be 1...n.

[--hitsperpage] hits-per-page

Specifies the number of hits per page that are displayed. It can be 1...n. For example, to display the hits in groups of 5 on the page, specify the value for hitsperpage as 5.

psadmin create-search-resourcedescription

Description

Creates a resource description in a search server.

Syntax

Long Format

psadmin create-search-resourcedescription --searchserver search-server-ID --file SOIF-filename --adminuser uid --passwordfile password-filename --database database-name [--debug] [--output output-filename] [--verbose]

Short Format

psadmin create-search-rd --s search-server-ID --file SOIF-filename -u uid -f password-filename --database database-name [--debug] [--output output-filename] [-v]

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.

[--file] SOIF-filename

Specifies the path and name of the SOIF file.

[--database] database-name

Specifies the database.

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 delete-search-resourcedescription

Description

Deletes resource descriptions from a search server.

Syntax

Long Format

psadmin delete-search-resourcedescription --searchserver search-server-ID --adminuser uid --passwordfile password-filename --urls '"URL1" "URL2" "..." "URLN"' --database database-name [--debug] [--output output-filename] [--verbose]

Short Format

psadmin delete-search-rd -s search-server-ID -u uid -f password-filename --urls '"URL1" "URL2" "..." "URLN"' --database database-name [--debug] [--output output-filename] [-v]

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.

[--urls] '"URL1" "URL2" "..." "URLN"'

Specifies a list of URLs. To pass a list of strings, use the format '” string1” “string2” “...” “stringN”'.

[--database] database-name

Specifies the database.

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 modify-search-resourcedescription

Description

Modifies a resource description in a search server.

Syntax

Long Format

psadmin modify-search-resourcedescription --searchserver search-server-ID --file SOIF-filename --adminuser uid --passwordfile password-filename --database database-name [--debug] [--output output-filename] [--verbose]

Short Format

psadmin modify-search-rd -s search-server-ID --file SOIF-filename -u uid -f password-filename --database database-name [--debug] [--output output-filename] [-v]

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.

[--file] SOIF-filename

Specifies the path and name of the SOIF file.

[--database] database-name

Specifies the database.

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.