Export (0) Print
Expand All
Expand Minimize

Command-line Parameters

Archived content. No warranty is made as to technical accuracy. Content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

Parameter

Short Form

Definition

Sample Values

access

-a

The level of access being granted.

One of the following values:administrators, authors, users, remove.Specifying remove removes all access for the account.

adminpassword

 

Use with owsrmadm to specify the password for the administrator to use to connect to the remote server.

The password for the valid administrator account on the server computer. Sample syntax:

owsrmadm -adminusername <username> -adminpassword <password> -target server <in the form http://servername:port/fpadmdll.dll on Windows® 2000 Server and Windows NT® 4.0 Server, http://servername:port/_sharepoint/fpadmdll.dll on Windows 2000 Professional or Windows NT 4.0 Workstation, or http://servername:port/fpadcgi.exe on UNIX>

adminusername

 

Use with owsrmadm to specify the administrator user name to use to connect to the remote server.

A valid administrator user name. The administrator must have rights to the server computer, as well as administrator rights to a Web site. Sample syntax:

owsrmadm -adminusername <username> -adminpassword <password> -target server <in the form http://servername:port/fpadmdll.dll on Windows 2000 Server and Windows NT 4.0 Server, http://servername:port/_sharepoint/fpadmdll.dll on Windows 2000 Professional or Windows NT 4.0 Workstation, or http://servername:port/fpadcgi.exe on UNIX>

clone

-c

Creates a role based on the specified role.

Any existing role

cloneright

-cr

Copies the rights from an existing role to a new role.

Any existing role

cloneusers

-cu

Copies the users from an existing role to a new role. Must be the last parameter in the syntax string when used.

Any existing role

command

-c

Specifies the command to perform.

Any command, such as add, del, set, and so on

databasename

-dn

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

-dp

Password for the SQL Server or MSDE database.

Defaults to blank ""

databaseserver

-ds

Server on which the SharePoint Team Services collaboration database exists.

Defaults to local machine name

databaseuser

-du

Administrator user name for the SQL Server or MSDE database.

Defaults to "sa"

description

-d

Description of a role.

Any text string

destination

-d

A URL of a file or folder in a FrontPage-extended web.

For the Putfile and Recalcfile commands, a URL relative to the top-level folder of the web, such as /myfolder/myfile.htm.

For the Setdirexec and Setdirnoexec commands, a folder URL relative to the top-level folder of the web, such as /myfolder/newfolder.

For the Rename command, a URL, relative to the root web, such as /newsubweb.

Default is web's root directory.

enablentlm

 

Enables or disables Windows Authentication (NTML).

 

erase

-e

Deletes a role.

 

filename

-f

A file name.

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

inherit

-i

A true or false value.

True or False

ipaddress

-i

An IP address.

An IP address, such as 172.22.12.12

limit

-l

The number of local accounts allowed on a virtual server.

A number, for example: "50".

multihost

-m

A virtual server's name or IP address. On IIS version 4.0 or later Web servers, this argument is used to specify an instance number.

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, an instance number, such as /LM/W3SVC/10.

The empty string "" signifies that the server is not multi-hosted.

name

-n

Name of role.

Any new or existing role: admin (Administrator), advauthor (Advanced Author), author, collab (Contributor), browser, and so on.

noChownContent Yes

 

A UNIX value specifying that only the contents of _vti* directories, and not users' content, is to be chowned.

None.

operation

-o

The operation to perform.

See the Command-line Operations topic for a list of available operations.

password

-pw

A password.

A password string, such as 124Xyz. This value is not needed on IIS servers.

port

-p

A port number.

An integer, such as 80, or a Web site name followed by an integer, such as sample.microsoft.com:80

You can also use -m InstanceNumber instead of -m HostName -p nnnn

Default is "80".

propertyname

-pn

A property name.

For values, see Command-line Properties.

propertyvalue

-pv

The value to set for a property.

For more information, see Command-line Properties.

rights

-r

The list of rights to set.

One or more right names. For example, "authorpages"

schedule

 

A time for a scheduled job.

A day and time in 24 hour format, for example: "weekly at Mon 8:17" or "monthly at 28 23:53"

servconf

-s

A UNIX Web server configuration file.

A full pathname, such as /usr/local/apache/conf/httpd.conf

siteprovision

-sp

Provisions a site when SharePoint Team Services is installed on a virtual server.

Windows only. One of the following values:

"publish" to install 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 page.

Default is "sharepthp".

targetserver

 

Use with owsrmadm to specify the server to administer remotely.

The path to the HTML Administration Pages on your server computer. Sample syntax:

owsrmadm -adminusername <username> -adminpassword <password> -target server <in the form http://servername:port/fpadmdll.dll on Windows 2000 Server and Windows NT 4.0 Server, http://servername:port/_sharepoint/fpadmdll.dll on Windows 2000 Professional or Windows NT 4.0 Workstation, or http://servername:port/fpadcgi.exe on UNIX>

username

-u

A user name.

Always use the short form for this parameter (-u).

On IIS, this value must be either a Windows NT user account name or a Windows NT group name, and can be qualified with a domain name, for example domain\username.

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

-u

A user name.

On IIS, this value must be either a Windows NT user account name or a Windows NT group name, and can be qualified with a domain name, for example domain\username.

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.

web

-w

The name of a Web site extended with SharePoint Team Services or FrontPage Server Extensions.

The URL of a folder, relative to the root of the content area, such as /myfolder. To specify the root web, use "/".

xgroup

-xg

A UNIX group account-name (this must be an existing account).

A UNIX group name, such as "www".

xuser

-xu

A UNIX user account-name (this must be an existing account).

A UNIX user account name.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft