Chapter 24 SharePoint Crawler psadmin Subcommands

This chapter list the following subcommands:

• get-sharepointcrawler-status

• start-sharepointcrawler

• stop-sharepointcrawler

• list-sharepointcrawler-sites

• create-sharepointcrawler-site

• modify-sharepointcrawler-site

• delete-sharepointcrawler-sites

• disable-sharepointcrawler-sites

• enable-sharepointcrawler-sites

get-sharepointcrawler-status

The get-sharepointcrawler-status subcommand displays the status of SharePoint crawler.

Long-Named Format

psadmin get-sharepointcrawler-status --adminuser admin_user [--passwordfile password_file] --searchserver searchserver_id

Short-Named Format

psadmin get-sharepointcrawler-status -u admin_user [-f password_file] -s searchserver_id

Options

These are the list of options available for the get-sharepointcrawler-status subcommand. The following two options are required:

[--adminuser | -u] uid

Specifies the distinguished name (DN) or the user identification name (uid) of the administrator.

[--searchserver | -s] searchserver_id

Search server id.

The following option is optional:

[--passwordfile | -f] passwordFile

Specifies the administrator password in the password file. When the --passwordfile option is specified, the password file should contain the password without any other text. If this option is not specified, the password will be prompted.

start-sharepointcrawler

The start-sharepointcrawler subcommand starts the SharePoint crawler.

Long-Named Format

psadmin start-sharepointcrawler --adminuser admin_user [--passwordfile password_file] --searchserver searchserver_id

Short-Named Format

psadmin start-sharepointcrawler -u admin_user [-f password_file] -s searchserver_id

Options

These are the list of options available for the start-sharepointcrawler subcommand. The following two options are required:

[--adminuser | -u] uid

Specifies the distinguished name (DN) or the user identification name (uid) of the administrator.

[--searchserver | -s] searchserver_id

Search server id.

The following option is optional:

[--passwordfile | -f] passwordFile

Specifies the administrator password in the password file. When the --passwordfile option is specified, the password file should contain the password without any other text. If this option is not specified, the password will be prompted.

stop-sharepointcrawler

The stop-sharepointcrawler subcommand stops the SharePoint crawler.

Long-Named Format

psadmin stop-sharepointcrawler --adminuser admin_user [--passwordfile password_file] --searchserver searchserver_id

Short-Named Format

psadmin stop-sharepointcrawler -u admin_user [-f password_file] -s searchserver_id

Options

These are the list of options available for the stop-sharepointcrawler subcommand. The following two options are required:

[--adminuser | -u] uid

Specifies the distinguished name (DN) or the user identification name (uid) of the administrator.

[--searchserver | -s] searchserver_id

Search server id.

The following option is optional:

[--passwordfile | -f] passwordFile

Specifies the administrator password in the password file. When the --passwordfile option is specified, the password file should contain the password without any other text. If this option is not specified, the password will be prompted.

list-sharepointcrawler-sites

The list-sharepointcrawler-sites subcommand displays all SharePoint crawling sites.

Long-Named Format

psadmin list-sharepointcrawler-sites --adminuser admin_user [--passwordfile password_file] --searchserver searchserver_id

Short-Named Format

psadmin list-sharepointcrawler-sites -u admin_user [-f password_file] -s searchserver_id

Options

These are the list of options available for the list-sharepointcrawler-sites subcommand. The following two options are required:

[--adminuser | -u] uid

Specifies the distinguished name (DN) or the user identification name (uid) of the administrator.

[--searchserver | -s] searchserver_id

Search server id.

The following option is optional:

[--passwordfile | -f] passwordFile

Specifies the administrator password in the password file. When the --passwordfile option is specified, the password file should contain the password without any other text. If this option is not specified, the password will be prompted.

create-sharepointcrawler-site

The create-sharepointcrawler-site subcommand creates a SharePoint crawling site.

Long-Named Format

psadmin create-sharepointcrawler-site --adminuser admin_user [--passwordfile password_file] --searchserver searchserver_id --url url [--name name] [--description description] [--database database] [--user user] [--password password] [--subsites state]

Short-Named Format

psadmin create-sharepointcrawler-site -u admin_user [-f password_file] -s searchserver_id -r url [-N name] [-c description] [-d database] [-U user] [-F password] [-S state]

Options

These are the list of options available for the create-sharepointcrawler-site subcommand. The following three options are required:

[--adminuser | -u] uid

Specifies the distinguished name (DN) or the user identification name (uid) of the administrator.

[--searchserver | -s] searchserver_id

Search server id.

[--url | -r] url

Site URL.

The following seven options are optional:

[--name | -N] name

Site name.

[--description | -c] description

Site description.

[--database | -d] database

Target search database.

[--user | -U] user

SharePoint user.

[--password | -F] password

SharePoint password.

[--subsites | -S] state

Process subsites (true/false).

[--passwordfile | -f] passwordFile

Specifies the administrator password in the password file. When the --passwordfile option is specified, the password file should contain the password without any other text. If this option is not specified, the password will be prompted.

modify-sharepointcrawler-site

The modify-sharepointcrawler-site subcommand modifies a SharePoint crawling site.

Long-Named Format

psadmin modify-sharepointcrawler-site --adminuser admin_user [--passwordfile password_file] --searchserver searchserver_id --site site_id [--url url] [--name name] [--description description] [--database database] [--user user] [--password password] [--subsites state]

Short-Named Format

psadmin modify-sharepointcrawler-site -u admin_user [-f password_file] -s searchserver_id -t site_id [-r url] [-N name] [-c description] [-d database] [-U user] [-F password] [-S state]

Options

These are the list of options available for the modify-sharepointcrawler-site subcommand. The following three options are required:

[--adminuser | -u] uid

Specifies the distinguished name (DN) or the user identification name (uid) of the administrator.

[--searchserver | -s] searchserver_id

Search server id.

[--site | -t] site_id

Site Id.

The following eight options are optional:

[--url | -r] url

Site URL.

[--name | -N] name

Site name.

[--description | -c] description

Site description.

[--database | -d] database

Target search database.

[--user | -U] user

SharePoint user.

[--password | -F] password

SharePoint password.

[--subsites | -S] state

Process subsites (true/false).

[--passwordfile | -f] passwordFile

Specifies the administrator password in the password file. When the --passwordfile option is specified, the password file should contain the password without any other text. If this option is not specified, the password will be prompted.

delete-sharepointcrawler-sites

The delete-sharepointcrawler-sites subcommand deletes SharePoint crawling sites.

Long-Named Format

psadmin delete-sharepointcrawler-sites --adminuser admin_user [--passwordfile password_file] --searchserver searchserver_id --sites site_ids

Short-Named Format

psadmin delete-sharepointcrawler-site -u admin_user [-f password_file] -s searchserver_id -T site_ids

Options

These are the list of options available for the delete-sharepointcrawler-site subcommand. The following three options are required:

[--adminuser | -u] uid

Specifies the distinguished name (DN) or the user identification name (uid) of the administrator.

[--searchserver | -s] searchserver_id

Search server id.

[--sites | -T] site_ids

Site ids in the format: ' ”site1”, “site2”, “site3” '.

The following option is optional:

[--passwordfile | -f] passwordFile

Specifies the administrator password in the password file. When the --passwordfile option is specified, the password file should contain the password without any other text. If this option is not specified, the password will be prompted.

disable-sharepointcrawler-sites

The disable-sharepointcrawler-sites subcommand disables SharePoint crawling sites.

Long-Named Format

psadmin disable-sharepointcrawler-sites --adminuser admin_user [--passwordfile password_file] --searchserver searchserver_id --sites site_ids

Short-Named Format

psadmin disable-sharepointcrawler-sites -u admin_user [-f password_file] -s searchserver_id -T site_ids

Options

These are the list of options available for the disable-sharepointcrawler-sites subcommand. The following three options are required:

[--adminuser | -u] uid

Specifies the distinguished name (DN) or the user identification name (uid) of the administrator.

[--searchserver | -s] searchserver_id

Search server id.

[--sites | -T] site_ids

Site ids in the format: ' “site1”, “site2”, “site3” '.

The following option is optional:

[--passwordfile | -f] passwordFile

Specifies the administrator password in the password file. When the --passwordfile option is specified, the password file should contain the password without any other text. If this option is not specified, the password will be prompted.

enable-sharepointcrawler-sites

The enable-sharepointcrawler-sites subcommand enables SharePoint crawling sites.

Long-Named Format

psadmin enable-sharepointcrawler-sites --adminuser admin_user [--passwordfile password_file] --searchserver searchserver_id --sites site_ids

Short-Named Format

psadmin enable-sharepointcrawler-sites -u admin_user [-f password_file] -s searchserver_id -T site_ids

Options

These are the list of options available for the enable-sharepointcrawler-sites subcommand. The following three options are required:

[--adminuser | -u] uid

Specifies the distinguished name (DN) or the user identification name (uid) of the administrator.

[--searchserver | -s] searchserver_id

Search server id.

[--sites | -T] site_ids

Site ids in the format: ' ”site1”, “site2”, “site3” '.

The following option is optional:

[--passwordfile | -f] passwordFile

Specifies the administrator password in the password file. When the --passwordfile option is specified, the password file should contain the password without any other text. If this option is not specified, the password will be prompted.