Command-Line Parameters (Windows SharePoint Services 2.0)

  • Article

The following table lists and explains the parameters you can use with operations for Stsadm.exe. For detailed information about the operations, including sample syntax, see Command-Line Operations (Windows SharePoint Services 2.0). For more information about using the command-line tool, see Introducing the Administration Tools for Windows SharePoint Services 2.0 in the Windows SharePoint Services Administrator's Guide.

Parameter Short form Definition Sample values

adcreation

Specifies that new user accounts are created in Microsoft Active Directory directory service.

add

Specifies that the user is added to a site group when the userrole operation is run.

addomain

The Active Directory domain.

admapcreatenew

Specifies that a new application pool is created in Internet Information Services (IIS).

admapidlogin

The user name to use for running processes in the administrative application pool.

This value must be a Microsoft Windows user name, and must be qualified with a domain name, for example DOMAIN\name.

admapidname

The administrative application pool ID.

admapidpwd

The password that corresponds to the admapidlogin.

admapidtype

The identity type to use for the administrative application pool.

(configurableid/ NetworkService/LocalService/LocalSystem)

adou

The Active Directory organizational unit (OU).

apcreatenew

-apnew

Specifies that a new application pool is created in Internet Information Services (IIS).

apidlogin

-apl

The user name to use for running processes in the application pool.

This value must be a Windows user name, and must be qualified with a domain name, for example DOMAIN\name.

apidname

The application pool ID.

apidpwd

The password that corresponds to the apidlogin.

apidtype

The identity type to use for the application pool.

(configurableid/ NetworkService/LocalService/LocalSystem)

codepage

The language codepage to use for e-mail messages.

This value must be a valid codepage, such as 65001.

connect

Connects to an existing database, rather than creating a new one.

convert

optional switch used in createweb operation to convert a folder to a subsite

databasename

-dn

The name of the Microsoft SQL Server database or Microsoft SQL Server 2000 Desktop Engine (Windows) (WMSDE) database used for Windows SharePoint Services data.

The default database name is automatically generated based on the machine name, virtual server, and subsite. For example, SharePoint_collab_stsid.

databasepassword

-dp

The password that corresponds to the administrator user name for the SQL Server database or WMSDE database.

databaseserver

-ds

The server on which the Windows SharePoint Services collaboration database exists.

The default is the local computer name. For example, SQL_01.

databaseuser

-du

The administrator user name for the SQL Server database or WMSDE database.

delete

Specifies that the user is deleted from a site group when the userrole operation is run.

deleteadaccounts

Specifies that users are deleted from Active Directory directory service when the deletesite operation is run.

deletecontent

Specifies that the content databases are deleted when a virtual server is unextended or Windows SharePoint Services is uninstalled.

description

-desc

The site or template description.

Any text string.

donotcreatesite

Specifies that no site is created when a virtual server is extended.

exclusivlyusentlm

New in Microsoft Windows SharePoint Services Service Pack 2 (SP2). Kerberos is enabled by default in Windows SharePoint Services SP2 using typical installation, eariler versions the default was ntlm.

-exclusivelyusentlm <yes/no>

filename

-f

A valid file name for a file, template, or Web Part package.

A full path and file name, such as C:\Myfiles\Filename.htm.

fromaddress

The e-mail address to use as a From address on server messages, such as alert notifications.

This value must be a valid e-mail address, in the form someone@example.com.

force

Specifies that an existing Web Part package is overwritten when the addwppack operation is run.

forceupgrade

Bypasses the initial SPVirtualServer.NeedUpgrade check and upgrades anyway. Useful when the SPVirtualServer object itself did not need upgrade, but the attached content databases still needed to be upgraded.

globalinstall

Specifies that, when the addwppack operation is run, the Web Part package is installed in the global assembly cache (GAC) rather than in the Bin directories of each virtual server. Assemblies installed in the GAC are available to all applications on the server.

hh

Specifies that the server is in a server farm hosting configuration. No database is created and the virtual server is extended by connecting to existing content database. You must specify an existing SQL connection string to the configuration database when you use this parameter.

incomingurl

New in Windows SharePoint Services SP2. Adds the ability to map an incoming URL for any requests that come from the reverse proxy server or client to an existing virtual server. You can map multiple incoming URLs to the same URL zone.

protocol://incoming.url.domain

lcid

The locale ID for sites created on this virtual server. Default is the install language for Windows SharePoint Services.

A locale ID, for example 1033.

name

-n

The name of a Web Part package.

newname

-new

The new name to use when renaming a subsite.

operation

-o

The operation to perform.

For a list of available operations, see Command-Line Operations (Windows SharePoint Services 2.0).

outsmtpserver

The SMTP server to use for outgoing messages.

overwrite

Specifies that any existing backup files or existing Web sites will be overwritten during backup or restore.

owneremail

The site owner's e-mail address.

This value must be a valid e-mail address, in the form someone@example.com.

ownerlogin

The site owner's user account.

This value must be a Windows user name, and must be qualified with a domain name, for example DOMAIN\name.

ownername

The site owner's display name.

port

The port to use for SharePoint Central Administration.

An integer, such as 80.

propertyname

-pn

A valid property name.

For names, see Command-Line Properties (Windows SharePoint Services 2.0).

propertyvalue

-pv

A valid property value.

For more information, see Command-Line Properties (Windows SharePoint Services 2.0).

quiet

used to prevent any console output

quota

-qt

The quota template to apply to sites created on the virtual server.

A quota template name. For example, personalquotas.

replytoaddress

The e-mail address that users can reply to when they receive server messages.

This value must be a valid e-mail address, in the form someone@example.com.

requiresecondarycontact

Specifies that users must supply a secondary contact when they create a new site.

role

A valid site group name.

For example, reader.

secondaryemail

-se

The secondary site owner's mail address.

This value must be a valid e-mail address, in the form someone@example.com.

secondarylogin

-sl

The secondary site owner's user account.

This value must be a Windows user name, and must be qualified with a domain name, for example DOMAIN\name.

secondaryname

-sn

The secondary site owner's display name.

servicename

-svc

The name of a data retrieval service.

For example, Service1.

setting

A setting for data retrieval services.

Any of the following values: enabled, responsesize, timeout, update.

siteadmin

Specifies that the user is an administrator of the site.

sitetemplate

-st

The template to apply to the new site.

The value must be in the form name#configuration. If you do not specify the configuration, configuration 0 is the default (for example, STS#0). The list of available templates can be customized to include templates you create.

Values available in a default installation include:

  • STS#0 (Team Site)

  • STS#1 (Blank Site)

  • STS#2 (Document Workspace)

  • MPS#0 (Basic Meeting Workspace)

  • MPS#1 (Blank Meeting Workspace)

  • MPS#2 (Decision Meeting Workspace)

  • MPS#3 (Social Meeting Workspace)

  • MPS#4 (Multipage Meeting Workspace)

    NoteNote:
    If you added a template to the central template gallery, you must specify the template name as _GLOBAL_# number, where number refers to the template ID.

ssl

Specifies that Secure Sockets Layer (SSL) encryption is used for the administration port.

title

-t

The template or site title

Any text string.

type

Type of path to add or remove.

(exclusion/explicitinclusion/wildcardinclusion)

unique

Specifies that the subsite uses unique permissions.

url

The URL to the virtual server, site, or subsite. If the virtual server is bound to a specific IP address or to a specific host header in Microsoft Internet Information Services (IIS), you can also use that IP address or host header as the value for this property.

NoteNote:
The value of this property is displayed in the Virtual Server List in SharePoint Central Administration.

For example, https://myserver/site1.

urlzone

New in Windows SharePoint Services SP2. Specifies which one of the five zones with which the outgoing URL is associated.

default, internet, intranet, extranet, or custom.

useremail

An e-mail address.

This value must be a valid e-mail address, in the form someone@example.com.

userlogin

A user account.

This value must be a Windows user name, and must be qualified with a domain name, for example DOMAIN\name.

username

-u

A user name.

Always use the short form for this parameter (u). This value must be either a Windows user account name or a Windows group account name, and can be qualified with a domain name, for example DOMAIN\name.

vsname

The virtual server name.

zonemappedurl

New in Windows SharePoint Services SP2. Maps the outgoing URL to the URL configured with the addalternatedomain operation. The outgoing URL is used in Web pages or e-mail messages going from the Web server to the reverse proxy server or the client. This URL is the one that can be reached by the end user. This step ensures that the end user sees the correct URL when the URL is returned from the server to the client.

-zonemappedurl <protocol://outgoing.url.domain>