Administrative Protocol Parameters

  • Article
  • 6 minutes to read

Administrative Protocol Parameters

The following table describes the parameters that can be used in administrative protocol with operations. For information regarding configuration properties that can be set with this protocol, see Administrative Protocol Properties. For information regarding the STSAdminXML elements that can be used in conjunction with parameters, see STSAdminXML Elements.

Parameters

Name Description
AccountName String specifying the server-qualified name of a Web site user, for example, servername\user1.
action Assigned an encrypted message for checking or fixing the server, specifying a comma- and pipe-delimited list of IDs (for example, 2|1|1,3|1|1,4|1|1,5|1|1) representing the problem to be checked (ProblemID), the scope of the problem (ScopeID), and action to be taken (ActionID). A fourth optional value can be specified by a text string.

ProblemID can be set to the following values:

  • 0 — Ensures that database information is synchronized with that of the SharePoint team Web site file system.
  • 1 — Checks the user and roles permissions that have been created for a team Web site and applies those security settings to the file system.
  • 2 — Verifies whether the subwebs on a root Web exist in the file structure.
  • 3 — Ensures that user role settings can be enforced.
  • 4 — Ensures that all necessary Web site files and directories are present and that only users with the proper permissions have access to them.
  • 5 — Checks the anonymous user access rights for the team Web sites and all subwebs to ensure that anonymous users have not been accidentally given more rights than are allowed by the role assigned to anonymous.

ScopeID can be set to the following values:

  • 0 — Machine-wide.
  • 1 — Virtual server.
  • 2 — Site-level.

ActionID can be set to the following values:

  • 0 — Ignore the problem.
  • 1 — Check the problem.
  • 2 — Check and fix the problem.

For more information on server health, see the SharePoint Team Services Administrator's Guide or the Help included with SharePoint Team Services from Microsoft.
cloneright Copies the rights from an existing role to a new role.
cloneuser When a role is cloned, determines whether users identified with the role are also copied into the new role. Can be set to any value.
command Specifies the command to perform in an operation. May be set to commands such as add, changepassword, del, delall, disable, or set.
dailyschedule Specifies that a daily schedule be used for subscription notifications. Can be set to a daily schedule format or to off. For example, "daily at 4:00:00".
databasename Name of the Microsoft SQL Server or MSDE database used for SharePoint Team Services data. The default database name is automatically generated based on the machine name, virtual server, and subweb.
databasepassword String specifying the administrator password for the SQL Server or MSDE database. The default value is an empty string.
databaseserver String specifying the name of the default server on which databases will be created when extending a new virtual server. Use the databaseconnection operation to change this setting. The default value is the local machine name.
databaseuser String specifying the administrator's user name for the SQL Server or MSDE database. The default value is "sa".
Dbschedule Used with the setproperty operation to schedule database backups. Can be set to a daily, weekly, or monthly schedule format or to off. For example, "daily at 4:00:00".
description String used to provide a description of a role.
EnableServerHealth Determines whether server health is enabled for the server. Can be set to TRUE or FALSE.
EnableUsageAnalysis Determines whether usage analysis is enabled for the server. Can be set to TRUE or FALSE.
filename String specifying the file name.
immidschedule Specifies that subscription notifications be sent. Can specify recurrent notifications by using the format "every n minutes", where n is an integer, or can be set to off.
inherit Specifies whether a new subweb inherits permissions from its parent Web. Can be set to TRUE or FALSE.
limit Specifies the number of local accounts allowed on a virtual server.
MSDE A Boolean value specifying whether the Microsoft Data Engine (MSDE) is the server being used for SharePoint Team Services. Can be set TRUE or FALSE.
multihost Specifies a virtual server's name or IP address. On Internet Information Services (IIS) version 4.0 or later Web servers, this argument is used to specify an instance number. This value can be an IP address or full WWW host name, as in 172.20.65.43 or sample.microsoft.com. On IIS version 4.0 or later, it can be an instance number, such as /LM/W3SVC/10. An empty string ("") signifies that the server is not multi-hosted.
name String that specifies the name of a role.
newpassword String specifying a new password for a new user account.
nextpage String that specifies the redirect page that the server returns when the operation is successful. If nextpage is not specified, the value of page is used for the redirect.
page String that specifies the administration page to be used for the operation. This parameter is required for operations and specifies the page to return when an error occurs.
password Confirmation string that is entered to verify a new password entered for a new user account. This value is not needed on IIS servers.
port Integer that specifies a port number. Can be a site name followed by an integer, as in sample.microsoft.com:80. The default value is 80.
PrevPage String specifying the previous page used in the Send an Invitation Wizard.
propertyname A string specifying the name of a property.
propertyvalue Specifies the value to which a property is set.
rights Specifies a comma-delimited list of the rights for a role. Can be set to any of the SharePoint Team Services user rights.
role A name that specifies either a predefined or custom role when a user is added. Predefined roles include the following values: admin, advauthor, author, browser, or collab. If the role assigned to this parameter doesn't exist for the specified Web, an error message is returned.
roles Specifies a list of roles when a user is added. Can be set to a custom role or to one of the following predefined values: admin, advauthor, author, collab, browser.
servconf Specifies the full pathname of a UNIX Web server configuration file, such as /usr/local/apache/conf/httpd.conf.
siteprovision Provisions a site when SharePoint Team Services is installed on a virtual server (Microsoft Windows only). Can be set to one of the following values:
  • publish to install Microsoft FrontPage Server Extensions 2002
  • collab to install SharePoint Team Services and create the collaboration database.
  • sharept to install SharePoint Team Services, create the collaboration database, and create a SharePoint team Web site.
  • sharepthp to install SharePoint Team Services, create the collaboration database, create a SharePoint team Web site, and replace the current default home page with the team Web site portal.
svrhealthschedule A variable used in setting the server's health schedule. Can be set to a daily, weekly, or monthly schedule format or to off. For example, "daily at 4:00:00".
thread An integer that specifies a discussion thread ID.
usageschedule Used with the setproperty and policies operations to schedule usage analysis. Can be set to a daily, weekly, or monthly schedule format or to off. For example, "daily at 4:00:00".
username A string that specifies the name of a Web site user and that can be qualified with a domain name, for example, domain\username. On IIS, this value must be either a Microsoft Windows NT user account name or a Windows NT group name. On UNIX, this is a new or existing user name in the Web server's access list. Do not use a UNIX user name for this value because it could be easily guessed.
users Specifies a comma-delimited list of user names.
web A string specifying the name of a Web site extended with SharePoint Team Services from Microsoft or Microsoft FrontPage Server Extensions. This value can be the URL of a folder, relative to the root of the content area, such as /myfolder. To specify the root Web, use "/".
weeklyschedule

Used with the setproperty and policies operations to schedule subscriptions. Can be set to a daily, weekly, or monthly schedule format or to off. For example, "weekly at sun 01:02:00".
xgroup A string specifying a UNIX group account name of an existing account.
xuser A string specifying a UNIX user account name of an existing account.