Administrative Protocol Operations

  • Artikel

Administrative Protocol Operations

This reference describes the HTTP-based protocol that can be used to remotely administer a Web site based on SharePoint Team Services from Microsoft or Microsoft FrontPage 2002 Server Extensions. You can use this protocol within custom forms to post requests to the ISAPI file fpadmdll.dll in Microsoft Windows (Program Files\Common Files\Microsoft Shared\web server extensions\50\isapi\_vti_adm folder) or to the CGI file fpadmcgi.exe on the UNIX platform (/user/local/frontpage/version5.0/exes/_vti_bin/_vti_adm folder). This protocol allows you to manage users and roles, to set database connection properties (in SharePoint Team Services only), to add, delete, or merge subwebs, and to set properties for a subweb, the root Web, or all Web sites on the server. This protocol requires that the user have Administrator rights on the server. For information about the administrative rights that can be set for a SharePoint team Web site, see User Rights.

The following example creates a new subweb that inherits permissions from the root Web:

<FORM id="frm" action="http://STSServer/_vti_bin/_vti_adm/fpadmdll.dll" method="post">
  <INPUT name="web" value="/Sub3">
  <INPUT name="operation" value="create">
  <INPUT name="page" value="newsbweb.htm">
  <INPUT name="nextpage" value="webadmin.htm">
  <INPUT name="inherit" value="true">
  <INPUT name="username" value="DomainName\UserName">
  <INPUT name="siteprovision" value="sharepthp">
  <INPUT type="submit">
</FORM>

The next example adds two rights to the already existing Manager role of the newly created subweb above:

<FORM id=formVars action="http://STSServer/Sub3/_vti_bin/_vti_adm/fpadmdll.dll"
  method="post">
  <INPUT name="description" value="Description">
  <INPUT name="operation" value="htmeditrole">
  <INPUT name="name" value="Manager">
  <INPUT name="rights" value="AuthorPages,ViewPages">
  <INPUT name="command" value="add">
  <INPUT name="page" value="editrole.htm">
  <INPUT name="nextpage" value="role.htm">
</FORM>
<INPUT onclick="formVars.submit();" type="button" value="Submit">

Note   For the UNIX operating system, replace the above path assigned to the action attribute with the full path to fpadmcgi.exe.

The following table describes the operations that can be performed in custom forms using the administrative protocol.

Note The multihost, port, and web parameters are valid only in the case of posting to a Global Administration port. The multihost and port parameters are required for virtual server operations, and the web parameter is required for site-level operations.

Operations

Name Description Parameters
accountlimits Sets limits on the number of local accounts that can be created for a virtual server. Also limits user accounts to a single virtual server.
  • limit (number of local accounts)
  • multihost
  • port (required if the port is not port 80, multihost is missing, or if multihost isn’t a metapath)
addremusers Adds or removes users to or from a team Web site. When command is set to add, this operation can be used to assign specific roles for a given user. In this case, use the roles parameter to specify a comma-delimited list of roles for the user. When set to del, the user parameter is required, which specifies user names in a comma-delimited string.
anonrole Specifies that a particular role can be used by anonymous users, or specifies that anonymous access is on or off.
  • command (can be disable or enable)
  • name (role)
  • multihost
  • port(required if the port is not port 80, multihost is missing, or if multihost isn’t a metapath)
  • web
backupdb Creates a backup of the SharePoint Team Services collaboration database. If the schedule parameter is present this command sets the timer. If the schedule parameter is missing this command does a database backup.
  • filename (name of backup file)
  • multihost
  • port(required if the port is not port 80, multihost is missing, or if multihost isn’t a metapath)
  • schedule
create Creates a subweb at the specified directory in an existing Web site. Note that for the create operation, the siteprovision values are slightly different. The publish value is not valid for a subweb of a SharePoint team Web site and is the only option for a FrontPage-based subweb, and the collab, sharept, and sharepthp values do not create new databases (database information is stored per virtual server, not per subweb).
databaseconnection Sets database information, such as database name, user name, or password. When changing the user name or password, databaseconnection verifies that the new settings are valid and returns an error if they are not. It also encrypts the account name and password before storing them. To change which database server is connected to a specific virtual server, the virtual server must first be unextended, and then re-extended with the new database settings. The changepassword parameter is only available with MSDE. To change a Microsoft SQL Server password, you must use the SQL Server administration tools.
delete Deletes the specified subweb on the specified virtual server and port. You cannot delete the root Web using this command; to delete the root Web, use the Uninstall operation. This command deletes all content, including all subwebs of the specified subweb.
  • multihost
  • port (required if the port is not port 80, multihost is missing, or if multihost isn’t a metapath)
  • web
deleteproperty Deletes a property. If the port parameter is specified, deletes the property of a specific virtual server; if the port parameter is missing, deletes a global property. The web parameter is used for source control since that is specific to a Web site.
  • multihost
  • port(required if the port is not port 80, multihost is missing, or if multihost isn’t a metapath)
  • propertyname (name of property to delete, which can be set to DiscussionsExpiry, EnableDiscussions, EnableNotifications, FolderSubscriptions, LocalDiscussionsOnly, MailReplyTo, MailSender, SourceControlProject, UsageAnalysisLogExpiry, UsageFullDaysOnly, UsageSendMailTo)
fulluninstall Uninstalls SharePoint Team Services or FrontPage Server Extensions 2002 on port nnnn of the specified virtual server. This operation also uninstalls the server extensions from any subwebs below the root Web and deletes the collaboration database. If you want to preserve the database during a full uninstall, set the command parameter to nodeldb.
htmeditrole Modifies the rights ascribed to an existing role and modifies the role description.
htmlcopyrole Creates a new role or clones an existing one to create a new role.
htmldbconnection Establishes a database connection for a team Web site.
install Installs SharePoint Team Services or FrontPage Server Extensions 2002 on the specified port of a virtual server, using the specified administrator name and password. If web is specified, the server extensions are installed on the named subweb. If no Web site name is specified, the server extensions are installed on the root Web of the specified virtual server.

If you are installing SharePoint Team Services, you must specify the databaseserver, databaseuser, databasepassword, and databasename to use, unless you are using MSDE, you have set your database parameters as installation defaults, or you are using a local SQL server with the default user name and password.

If you are installing FrontPage Server Extensions 2002, you do not need these parameters. On UNIX, you must specify a server configuration file. On Windows, use siteprovision to specify whether to provision a SharePoint team Web site.
merge Uninstalls the server extensions on the specified subweb. This converts the subweb into a folder of its parent Web site. Any subwebs below the specified subweb are promoted to be subwebs under the parent Web site. Do not merge a subweb if it contains document libraries or lists based on SharePoint Team Services, such as discussion boards or task lists, as these items are corrupted if they are merged into a parent Web site. If you do want to merge a subweb that contains lists, you can copy the data out of the list, merge the subweb, and then recreate the list.
  • multihost
  • port (required if the port is not port 80, multihost is missing, or if multihost isn’t a metapath)
  • web
mngdisc For the virtual server only, a user with the ManageDiscussions right can view a paged, filtered list of discussion threads recoded on the current virtual server and can delete all or only specified subscription items. This operation deletes the comma-delimited list of thread IDs specified by thread, or all threads if this parameter specifies an empty string ("").
mngpersub A user with the Subscribe right for a personal subscription list can see the list of subscriptions and can delete specified subscription items. This operation deletes the comma-delimited list of thread IDs specified by thread.
mngsub For the virtual server only, the user with ManageSubscriptions right can see a paged, filtered, sorted list of subscriptions recoded on the current virtual server and can delete specified subscription items. This operation deletes the comma-delimited list of thread IDs specified by thread.
policies Sets properties on the global level (All Ports section in the registry) and executes a databaseconnection operation.
recalc Synchronizes content databases with the current state of the Web site. Recalculates and repairs all internal hyperlinks in the specified Web site on the specified virtual server and port. This command also reincludes pages in Include Page components, recalculates other components (such as search forms and navigation bars), reapplies borders to any pages that use borders, resets permissions on the form handler result pages, reindexes categories, and recalculates text indexes.
  • multihost
  • port (required if the port is not port 80, multihost is missing, or if multihost isn’t a metapath)
  • web
restoredb Restores a backup of the SharePoint Team Services collaboration database.
rightsmask Specifies which rights are available for use on a server.
  • command (can be add, set, del, or delall)
rolerights Adds, deletes, or deletes all rights for a given role.
roles Creates a new role. If the cloneright parameter is used, the new role is based on an existing role. If cloneusers is used, it clones the users as well.
roleusers Adds or deletes specific users or all users for a given role.
serverhealth For a virtual server, detects and repairs common server problems. You must be an administrator of the virtual server, or have the Manage Server Health right to run a server health check.
setperms Specifies whether to inherit permissions from the parent Web site.
setproperty Sets a property. If the port parameter is used, sets the property of a specific virtual server; if the port parameter is missing, sets a global property. The web parameter is used for source control since that is specific to a Web site.
uninstall Uninstalls SharePoint Team Services or FrontPage Server Extensions 2002 on port nnnn of the specified virtual server. This also uninstalls the server extensions from any subwebs below the root Web.
upgrade Upgrades port nnnn of the specified virtual server to SharePoint Team Services or FrontPage Server Extensions 2002. The root Web of the specified virtual server is upgraded, and any subwebs of the root Web are also upgraded.
userroles Adds or deletes specific roles or all roles for a given user.
users Adds or deletes users to the Web site, also used to change the password for a user.
  • command (can be add, del, or changepassword)
  • multihost
  • port(required if the port is not port 80, multihost is missing, or if multihost isn’t a metapath)
  • username