Export (0) Print
Expand All
Expand Minimize

Command-line Operations

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.

This topic lists and explains the operations you can perform with Owsadm.exe and Owsrmadm.exe. For detailed information about the required and optional parameters, including short forms of the parameters, see Command-line Parameters. For more information about using the command-line tools, see Command-line Administration.

On This Page

AccountLimits
Anonrole
BackupDB
Check
Chown (UNIX only)
Create
DatabaseConnection
Delete
DeleteAdminport (UNIX only)
DeleteProperty
Disable
Enable
Fulluninstall
GetAdminport
GetProperty
Install
Merge
Putfile
Recalc
Recalcfile
Rename
RestoreDB
Rightsmask
Rolerights
Roles
Roleusers
SetAdminport
Setdirexec
Setdirnoexec
Setperms
SetProperty
Uninstall
Upgrade
Usage
Userroles
Users

AccountLimits

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

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.

Required parameters

Optional parameters

-limit <number of local accounts>

-port <port> (required if the port is not port 80, multihost is missing, or if multihost isnt a metapath)

-multihost

Sample syntax:

owsadm -o accountlimits -l <number of local accounts> [-p <port> 
-m <name>]

Anonrole

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

Specifies that a particular role can be used by anonymous users, or specifies that anonymous access is on or off.

Required parameters

Optional parameters

-web

-command (add, set, del, delall, enable, disable)

-name <role>

Sample syntax:

owsadm -o anonrole -w <name of web> [-c <add/set/del/delall> -n <role>]

– or –

owsadm -o anonrole -c <enable/disable> -w /

BackupDB

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

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 log analysis.

Required parameters

Optional parameters

No required parameters

-filename <name of backup file>

-port <port>

-schedule

Sample syntax:

owsadm -o backupdb [-s <date and time> -p <port> -m <name>

Check

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

Checks and fixes SharePoint Team Services or Microsoft FrontPage 2002 Server Extensions installation on port nnnn of the specified virtual server. If the -web parameter is specified, the server extensions are checked on the named subweb. Otherwise, the server extensions are checked on the root web of the specified virtual server. If the Web site you are checking has subwebs, those are checked also. Use the –schedule parameter to specify a time/day/month/year to run server health checks.

Required parameters

Optional parameters

No required parameters

-schedule <date and time>

-port <port> (required if the port is not port 80, multihost is missing, or if multihost isnt a metapath)

-multihost

Sample syntax:

owsadm -o check [-s <date and time> -p <port> -m <name>]

Chown (UNIX only)

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

Changes ownership for the virtual server.

Required parameters

Optional parameters

-xuser

-xgroup

-port <port> (required if multihost is missing, or if multihost isnt a metapath)

-multihost

Sample syntax:

owsadm -o chown -xu <username> [-xg <groupname> -p <port> -m <name>]

Create

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

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).

Required parameters

Optional parameters

-web <webname>

-port <port>

-multihost

-siteprovision <publish/collab/sharept/sharepthp>

Optional for UNIX:

-xuser

-xgroup

Sample syntax:

owsadm -o create -w <web name> [-p <port> -m <name> 
-sp <publish/collab/sharept/sharepthp>]

DatabaseConnection

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

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 it. 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 SQL Server password, you must use the SQL Server administration tools.

Required parameters

Optional parameters

No required parameters

-port <port>

-databaseserver

–databaseuser

–databasepassword

–databasename

-c changepassword <new password>

Sample syntax:

owsadm -o databaseconnection [-p <port> -ds <servername> -dn <database name> -du <username> -dp <password> -c changepassword <new password>]

Delete

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

Deletes the subweb <web name> 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.

Required parameters

Optional parameters

-web

-port <port> (required if the port is not port 80, multihost is missing, or if multihost isnt a metapath)

-multihost

Sample syntax:

owsadm -o delete -w <webname> [-p <port> -m <name>]

DeleteAdminport (UNIX only)

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

This UNIX-only command deletes the administration port. Use only if you don't want to use HTML Administration for your Web sites.

Required parameters

Optional parameters

-servconf (required UNIX only)

 

Sample syntax:

owsadm -o deleteadminport -s <filename>

DeleteProperty

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

Deletes any of the properties you can change using SetProperty. Parameters are the same as that of SetProperty except the -propertyvalue parameter isnt used.

Required parameters

Optional parameters

-propertyname <name of property to change>

-web <name of web>

-port <port>

Sample syntax:

owsadm -o deleteproperty -pn <name of property> [-w <webname> -p <port>]

Disable

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

Disables authoring and administering from the FrontPage client on port nnnn of the specified virtual server.

Required parameters

Optional parameters

No required parameters

-port <port> (required if the port is not port 80, multihost is missing, or if multihost isnt a metapath)

-multihost

Sample syntax:

owsadm -o disable [-p <port> -m <name>]

Enable

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

Enables authoring and administering from the FrontPage client on port nnnn of the specified virtual server.

Required parameters

Optional parameters

No required parameters

-port <port> (required if the port is not port 80, multihost is missing, or if multihost isnt a metapath)

-multihost

Sample syntax:

owsadm -o enable [-p <port> -m <name>]

Fulluninstall

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

Uninstalls SharePoint Team Services or FrontPage 2002 Server Extensions 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 fulluninstall, use the -c nodeldb parameter.

Required parameters

Optional parameters

-port <port>

-multihost (can be used instead of -port)

-c nodeldb

Sample syntax:

owsadm -o fulluninstall [-p <port> -m <name> -c nodeldb]

GetAdminport

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

Displays the port number of the global administration virtual server.

Required parameters

Optional parameters

-servconf (required UNIX only)

 

Sample syntax:

owsadm -o getadminport -s <filename>

GetProperty

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

Displays the property setting for the specified property.

Required parameters

Optional parameters

-propertyname <name of property to change>

-web <name of web>

-port <port>

Sample syntax:

owsadm -o getproperty -pn <name of property> [-w <web> -p <port>]

Install

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

Installs SharePoint Team Services or FrontPage 2002 Server Extensions 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 2002 Server Extensions, 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.

Required parameters

Optional parameters

-username <username> (required if access control supported)

Required for UNIX:

-servconf

-xuser

-databaseserver

-databasename

-databaseuser

-databasepassword

-port <port>

-multihost

-siteprovision (Windows only) <publish/collab/sharept/sharepthp>

-enablentlm

Optional for UNIX:

-xgroup

-nochowncontent yes

-password

Sample syntax (Windows):

owsadm -o install -u <username> [-ds <servername> -dn <database name> 
-du <username> -dp <password> -p <port> -m <name> 
-sp <publish/collab/onet/onethp>]

Sample syntax (UNIX):

owsadm -o install -xu <username> -s <filename> 
[-xg <groupname> -nochowncontent yes -pw <password>

Merge

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

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 will be 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.

Required parameters

Optional parameters

-web

-port <port> (required if the port is not port 80, multihost is missing, or if multihost isnt a metapath)

-multihost

Sample syntax:

owsadm -o merge -w <web> [-p <port> -m <name>]

Putfile

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

Imports the file -filename as the file -destination to the specified Web site on the virtual server and port. Note that the source file name is always relative to the server.

Required parameters

Optional parameters

-destination

-filename

-web (default is root web)

-port <port> (required if the port is not port 80, multihost is missing, or if multihost isnt a metapath)

-multihost

Sample syntax:

owsadm -o putfile -d <path> -f <filename> [-w <web> -p <port> -m <name>]

Recalc

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

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.

Required parameters

Optional parameters

-web

-port <port> (required if the port is not port 80, multihost is missing, or if multihost isnt a metapath)

-multihost

Sample syntax:

owsadm -o recalc -w <web> [-p <port> -m <name>]

Recalcfile

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

Recalculates and repairs all internal hyperlinks at the specified URL destination in the specified Web site on the virtual server and port. This command also reincludes pages in Include Page components and recalculates text indexes.

Required parameters

Optional parameters

-destination

-web (default is root web) -port <port> (required if the port is not port 80, multihost is missing, or if multihost isnt a metapath)

-multihost

Sample syntax:

owsadm -o recalcfile -d <destination> [-w <web> -p <port> -m <name>]

Rename

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

Renames the specified subweb on the virtual server and port to the new Web site name and destination.

Required parameters

Optional parameters

-web

-destination

-port <port> (required if multihost is missing or if multihost isnt a metapath)

-multihost

Sample syntax:

owsadm -o rename -w <web> -d <destination> [-p <port> -m <name>]

RestoreDB

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

Restores a backup of the SharePoint Team Services collaboration database.

Required parameters

Optional parameters

No required parameters

-port <port>

-filename

Sample syntax:

owsadm -o restoredb [-p <port> -m <name>]

Rightsmask

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

Specifies the rights available for use on a server.

Required parameters

Optional parameters

-command (add, set, del, or delall)

-port <port>

-rights

Sample syntax:

owsadm -o rightsmask -c <add/set/del/delall> [-p <port> -r <right,right>]

Rolerights

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

Adds, deletes or deletes all rights for a given role. For more information about the rights that can be set, see the User Rights topic.

Required parameters

Optional parameters

-command (add, del, or delall)

–web

-name <role>

-port <port>

-rights <rights for the role>

Sample syntax:

owsadm -o rolerights -c <add/del/delall> -w <web> -n <role> [-p <port> 
-r <right,right>]

Roles

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

Creates a new role. If -cloneright is used, the new role is based on an existing role. If -cloneusers is used, it clones the users as well. Note that if you use -cloneusers, it must be the last parameter in the syntax. Using the -erase parameter deletes the role.

Required parameters

Optional parameters

-command (add or del)

–web

-name <role>

-port <port>

-description <description>

-cloneright

-cloneusers

Sample syntax:

owsadm -o roles -c <add/del> -w <web> -n <name> [-p <port> 
-d <description> -cr -cu]

Roleusers

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

Adds, deletes, or deletes all users for a given role.

Required parameters

Optional parameters

-command (set, add, del, or delall)

–web

-name <role>

-port <port>

-multihost

-users <username,username>

Sample syntax:

owsadm -o roleusers -c <add/set/del/delall> -w <web> -n <name> [-p <port> 
-m <name> -u <username, username>]

SetAdminport

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

Changes the port number of the global administration server to that supplied by the -port parameter.

Required parameters

Optional parameters

-port <new admin port>

-username <username>

-servconf (required UNIX only)

-password <password>

Sample syntax:

owsadm -o setadminport -p <port> -u <username> [-s <filename> 
-ps <password>]

Setdirexec

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

Specifies that the directory destination can contain executable programs in the specified Web site on the virtual server and port.

Required parameters

Optional parameters

No required parameters

-web (default is root web)

-destination (default is web's root directory)

-port <port> (required if the port is not port 80, multihost is missing, or if multihost isnt a metapath)

-multihost

Sample syntax:

owsadm -o setdirexec [-w <web> -d <URL> -p <port> -m <name>]

Setdirnoexec

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

Specifies that the directory destination cannot contain executable programs in the specified Web site on the virtual server and port.

Required parameters

Optional parameters

-destination (default is the Web sites root directory)

-web (default is root web)

-port <port> (required if the port is not port 80, multihost is missing, or if multihost isnt a metapath)

-multihost

Sample syntax:

owsadm -o setdirnoexec -d <URL> [-w <web> -p <port> -m <name>]

Setperms

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

Specifies whether to inherit permissions from the parent Web site.

Required parameters

Optional parameters

-web

-inherit (true/false)

 

Sample syntax:

owsadm -o setperms -w <web> -i <true/false>

SetProperty

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

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.

Required parameters

Optional parameters

-propertyname <name of property to change>

-web <name of web>

-port <port>

-propertyvalue <new value of property>

Sample syntax:

owsadm -o setproperty -pn <name of property> [-w <web> -p <port> 
-pv <value>]

Secondary usage:

Sets all properties to be inherited from the server settings, rather than using individual Web site settings.

Required parameters

Optional parameters

-web <name of web>

-inherit

-port <port>

-username <username>

Sample syntax:

owsadm -o setproperty -w <web> -i <true/false> [-p <port> -u <username>]

Uninstall

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

Uninstalls SharePoint Team Services or FrontPage 2002 Server Extensions on port nnnn of the specified virtual server. This also uninstalls the server extensions from any subwebs below the root web.

Required parameters

Optional parameters

-port <port>

-multihost (can be used instead of -port)

Sample syntax:

owsadm -o uninstall [-p <port> -m <name>]

Upgrade

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

Upgrades port nnnn of the specified virtual server to SharePoint Team Services or FrontPage 2002 Server Extensions. The root web of the specified virtual server is upgraded, and any subwebs of the root web are also upgraded.

Required parameters

Optional parameters

Required for UNIX:

-xuser

-port <port> (required if the port is not port 80, multihost is missing, or if multihost isnt a metapath)

-multihost

-databaseserver

-databasename

-databaseuser

-databasepassword

-siteprovision

For UNIX:

-xgroup

Sample syntax (Windows):

owsadm -o upgrade [-p <port> -m <name> -ds <servername> -dn 
<databasename> -du <username> -dp <password> -sp 
<publish/collab/sharept/sharepthp>]

Sample syntax (UNIX):

owsadm -o upgrade -xu <username> [-xg <groupname> \-p <port> -m <name>]

Usage

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

Runs usage analysis reports. Use the –schedule parameter to specify a time/day/month/year to run the usage analysis reports.

Required parameters

Optional parameters

No required parameters

-schedule

-port <port>

Sample syntax:

owsadm -o usage [-s <date and time> -p <port>]

Sample command:

owsadm -o usage -port 80 -schedule "Mon at 8:17"

Userroles

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

Adds, deletes or deletes all roles for a given user.

Required parameters

Optional parameters

-command (set, add, del, or delall)

-username <username>

-web

-port <port>

-name <role,role>

Sample syntax:

owsadm -o userroles -c <add/set/del/delall> -u <username> -w <web> 
[-p <port> -n <role,role>]

Users

 Cc768031.spacer(en-us,TechNet.10).gif Cc768031.spacer(en-us,TechNet.10).gif

Adds or deletes users to the Web site, also used to change the password for a user.

Required parameters

Optional parameters

-command (add, del, or changepassword)

-username <username>

-port <port>

Sample syntax:

owsadm -o users -c <add/del/changepassword> -u <username> [-p <port>]

Cc768031.spacer(en-us,TechNet.10).gif

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