Friday 28 December 2012

Complete reference of all STSADM operations


This is an update to my complete reference of all STSADM operations in Microsoft Office SharePoint Server 2007, now including the changes in Service Pack 1. I repeated what I did for MOSS 2007 in MOSS 2007 SP1, using a little scripting to get the list of all commands for STSADM, including the options and parameters for each. Items new in SP1 are underlined. Please note that some defaults might be related to the way my server is configured.
  1. stsadm -o activatefeature {-filename <relative path to Feature.xml> | -name <feature folder> | -id <feature Id>} [-url <url>] [-force]
  2. stsadm -o activateformtemplate -url <URL to the site collection> [-formid <form template ID>] [-filename <path to form template file>]
  3. stsadm -o addalternatedomain -url <protocol://existing.WebApplication.URLdomain> -incomingurl <protocol://incoming.url.domain> -urlzone <default, extranet, internet, intranet, custom> -resourcename <non-web application resource name>
  4. stsadm -o addcontentdb -url <url> -databasename <database name> [-databaseserver <database server name>] [-databaseuser <database username>] [-databasepassword <database password>] [-sitewarning <site warning count>] [-sitemax <site max count>]
  5. stsadm -o adddataconnectionfile -filename <path to file to add> [-webaccessible <bool>] [-overwrite <bool>] [-category <bool>]
  6. stsadm -o add-ecsfiletrustedlocation -Ssp <SSP name> -Location <URL|UNC> -LocationType SharePoint|Unc|Http -IncludeChildren True|False [-SessionTimeout <time in seconds>] [-ShortSessionTimeout <time in seconds>] [-MaxRequestDuration <time in seconds>] [-MaxWorkbookSize <file size in Mbytes>] [-MaxChartSize <size in Mbytes>] [-VolatileFunctionCacheLifetime <time in seconds>] [-DefaultWorkbookCalcMode File|Manual|Auto|AutoDataTables] [-AllowExternalData None|Dcl|DclAndEmbedded] [-WarnOnDataRefresh True|False] [-StopOpenOnRefreshFailure True|False] [-PeriodicCacheLifetime <time in seconds>] [-ManualCacheLifetime <time in seconds>] [-MaxConcurrentRequestsPerSession <number of requests>] [-AllowUdfs True|False] [-Description <descriptive text>]
  7. stsadm -o add-ecssafedataprovider -Ssp <SSP name> -ID <data provider id> -Type Oledb|Odbc|OdbcDsn [-Description <descriptive text>]
  8. stsadm -o add-ecstrusteddataconnectionlibrary -Ssp <SSP name> -Location <URL> [-Description <descriptive text>]
  9. stsadm -o add-ecsuserdefinedfunction -Ssp <SSP name> -Assembly <strong name|file path> -AssemblyLocation GAC|File [-Enable True|False] [-Description <descriptive text>]
  10. stsadm -o addexemptuseragent -name <user-agent to receive InfoPath files instead of a Web page>
  11. stsadm -o addpath -url <url> -type <explicitinclusion/wildcardinclusion>
  12. stsadm -o addpermissionpolicy -url <url> -userlogin <login name> -permissionlevel <permission policy level> [-zone <URL zone>] [-username <display name>]
  13. stsadm -o addsolution -filename <Solution filename> [-lcid <language>]
  14. stsadm -o addtemplate -filename <template filename> -title <template title> [-description <template description>]
  15. stsadm -o adduser -url <url> -userlogin <DOMAIN\user> -useremail <email address> -role <role name> / -group <group name> -username <display name> [-siteadmin]
  16. stsadm -o addwppack  -filename <Web Part Package filename> [-lcid <language>] [-url <url>] [-globalinstall] [-force] [-nodeploy]
  17. stsadm -o addwppack  -name <name of Web Part Package> [-lcid <language>] [-url <url>] [-globalinstall] [-force]
  18. stsadm -o addzoneurl -url <protocol://existing.WebApplication.URLdomain> -urlzone <default, extranet, internet, intranet, custom> -zonemappedurl <protocol://outgoing.url.domain> -resourcename <non-web application resource name>
  19. stsadm -o allowuserformwebserviceproxy -url <Url of the web application> -enable <true to enable, false to disable>
  20. stsadm -o allowwebserviceproxy -url <Url of the web application> -enable <true to enable, false to disable>
  21. stsadm -o associatewebapp -title <SSP name> [-default | -parent] -url <Web application 1 url,Web application 2 url> [-all]
  22. stsadm -o authentication -url <url> -type <windows/forms/websso> [-usebasic (valid only in windows authentication mode)] [-usewindowsintegrated (valid only in windows authentication mode)] [-exclusivelyusentlm (valid only in windows authentication mode)] [-membershipprovider <membership provider name>] [-rolemanager <role manager name>] [-enableclientintegration] [-allowanonymous]
  23. stsadm -o backup -url <url> -filename <filename> [-overwrite]
  24. stsadm -o backup -directory <UNC path> -backupmethod <full | differential> [-item <created path from tree>] [-percentage <integer between 1 and 100>] [-backupthreads <integer between 1 and 10>] [-showtree] [-quiet]
  25. stsadm -o backuphistory -directory <UNC path> [-backup] [-restore]
  26. stsadm -o binddrservice -servicename <data retrieval service name> -setting <data retrieval services setting>
  27. stsadm -o blockedfilelist -extension <extension> -add [-url <url>]
  28. stsadm -o blockedfilelist -extension <extension> -delete [-url <url>]
  29. stsadm -o canceldeployment -id <id>
  30. stsadm -o changepermissionpolicy -url <url> -userlogin <DOMAIN\name> [-zone <URL zone>] [-username <display name>] [{ -add | -delete } -permissionlevel <permission policy level>]
  31. stsadm -o copyappbincontent
  32. stsadm -o createadminvs [-admapidname <app pool name>] [-admapidtype <configurableid/NetworkService>] [-admapidlogin <DOMAIN\name>] [-admapidpwd <app pool password>]
  33. stsadm -o createcmsmigrationprofile -profilename <profile name> [-description <description>] [-connectionstring <connection string>] -databaseserver <server>  -databasename <name>  -databaseuser <username>  [-databasepassword <password>] [-auth windowsauth|sqlauth] -destination <url> [-rootchannel <channelname>] [-destinationlocale <LCID>] [-migrateresources onlyused|all] [-migrateacls yes|no] [-emailto <address1;address2>] [-emailon success|failure|none|both] [-keeptemporaryfiles Never|Always|Failure] [-enableeventreceivers yes|no]
  34. stsadm -o creategroup -url <url> -name <group name> -description <description> -ownerlogin <DOMAIN\name or group name> [-type member|visitor|owner]
  35. stsadm -o createsite -url <url> -owneremail <email address> [-ownerlogin <DOMAIN\name>] [-ownername <display name>] [-secondaryemail <email address>] [-secondarylogin <DOMAIN\name>] [-secondaryname <display name>] [-lcid <language>] [-sitetemplate <site template>] [-title <site title>] [-description <site description>] [-hostheaderwebapplicationurl <web application url>] [-quota <quota template>]
  36. stsadm -o createsiteinnewdb -url <url> -owneremail <email address> [-ownerlogin <DOMAIN\name>] [-ownername <display name>] [-secondaryemail <email address>] [-secondarylogin <DOMAIN\name>] [-secondaryname <display name>] [-lcid <language>] [-sitetemplate <site template>] [-title <site title>] [-description <site description>] [-hostheaderwebapplicationurl <web application url>] [-quota <quota template>] [-databaseuser <database username>] [-databasepassword <database password>] [-databaseserver <database server name>] [-databasename <database name>]
  37. stsadm -o createssp -title <SSP name> -url <Web application url> -mysiteurl <MySite Web application url> -ssplogin <username> -indexserver <index server> -indexlocation <index file path> [-ssppassword <password>] [-sspdatabaseserver <SSP database server>] [-sspdatabasename <SSP database name>] [-sspsqlauthlogin <SQL username>] [-sspsqlauthpassword <SQL password>] [-searchdatabaseserver <search database server>] [-searchdatabasename <search database name>] [-searchsqlauthlogin <SQL username>] [-searchsqlauthpassword <SQL password>] [-ssl <yes|no>]
  38. stsadm -o createweb -url <url> [-lcid <language>] [-sitetemplate <site template>] [-title <site title>] [-description <site description>] [-convert] [-unique]
  39. stsadm -o databaserepair -url <url> -databasename <database name> [-deletecorruption]
  40. stsadm -o deactivatefeature {-filename <relative path to Feature.xml> | -name <feature folder> | -id <feature Id>} [-url <url>] [-force]
  41. stsadm -o deactivateformtemplate -url <URL to the site collection> [-formid <form template ID>] [-filename <path to form template file>]
  42. stsadm -o deleteadminvs
  43. stsadm -o deletealternatedomain -url <ignored> -incomingurl <protocol://incoming.url.domain>
  44. stsadm -o deletecmsmigrationprofile -profilename <profile name>
  45. stsadm -o deleteconfigdb
  46. stsadm -o deletecontentdb -url <url> -databasename <database name> [-databaseserver <database server name>]
  47. stsadm -o deletegroup -url <url> -name <group name>
  48. stsadm -o deletepath -url <url>
  49. stsadm -o deletepermissionpolicy -url <url> -userlogin <login name> [-zone <URL zone>]
  50. stsadm -o deletesite -url <url> -deleteadaccounts <true/false>
  51. stsadm -o deletesolution -name <Solution name> [-override] [-lcid <language>]
  52. stsadm -o deletessp -title <SSP name> [-deletedatabases]
  53. stsadm -o deletessptimerjob -title <SSP Name> -jobid <SSP Timer Job Id>
  54. stsadm -o deletetemplate -title <template title> [-lcid <language>]
  55. stsadm -o deleteuser -url <url> -userlogin <DOMAIN\name> [-group <group>]
  56. stsadm -o deleteweb -url <url>
  57. stsadm -o deletewppack -name <name of Web Part Package> [-lcid <language>] [-url <url>]
  58. stsadm -o deletezoneurl -url <protocol://existing.WebApplication.URLdomain> -urlzone <default, extranet, internet, intranet, custom> -resourcename <non-web application resource name>
  59. stsadm -o deploysolution -name <Solution name> [-url <virtual server url>] [-allcontenturls] [-time <time to deploy at>] [-immediate] [-local] [-allowgacdeployment] [-allowcaspolicies] [-lcid <language>] [-force]
  60. stsadm -o deploywppack -name <Web Part Package name> [-url <virtual server url>] [-time <time to deploy at>] [-immediate] [-local] [-lcid <language>] [-globalinstall] [-force]
  61. stsadm -o disablessc -url <url>
  62. stsadm -o displaysolution -name <Solution name>
  63. stsadm -o editcmsmigrationprofile -profilename <profile name> [-description <description>] [-connectionstring <connection string>] [-databaseserver <server>] [-databasename <name>] [-databaseuser <username>] [-databasepassword <password>] [-auth sqlauth|windowsauth] [-emailto <address1;address2>] [-emailon success|failure|none|both] [-excludeschema ] [-keeptemporaryfiles Never|Always|Failure] [-enableeventreceivers yes|no]
  64. stsadm -o editcontentdeploymentpath -pathname <path name> [-keeptemporaryfiles Never|Always|Failure] [-enableeventreceivers yes|no] [-enablecompression yes|no]
  65. stsadm -o editssp -title <SSP name> [-newtitle <new SSP name>] [-sspadminsite <administration site url>] [-ssplogin <username>] [-ssppassword <password>] [-indexserver <index server>] [-indexlocation <index file path>] [-setaccounts <process accounts (domain\username)>] [-ssl <yes|no>]
  66. stsadm -o email -outsmtpserver <SMTP server> -fromaddress <email address> -replytoaddress <email address> -codepage <codepage> [-url <url>]
  67. stsadm -o enablecmsurlredirect -profilename <profile name> -off
  68. stsadm -o enablessc -url <url> [-requiresecondarycontact]
  69. stsadm -o enumalternatedomains -url <protocol://existing.WebApplication.URLdomain> -resourcename <non-web application resource name>
  70. stsadm -o enumcontentdbs -url <url>
  71. stsadm -o enumdataconnectionfiledependants -filename <filename for which to enumerate dependants>
  72. stsadm -o enumdataconnectionfiles [-mode <a | u | all | unreferenced>]
  73. stsadm -o enumdeployments
  74. stsadm -o enumexemptuseragents
  75. stsadm -o enumformtemplates
  76. stsadm -o enumgroups -url <url>
  77. stsadm -o enumroles -url <url>
  78. stsadm -o enumservices
  79. stsadm -o enumsites -url <virtual server url> -showlocks -redirectedsites
  80. stsadm -o enumsolutions
  81. stsadm -o enumssp -title <SSP name> [-default | -parent | -all]
  82. stsadm -o enumssptimerjobs -title <SSP Name>
  83. stsadm -o enumsubwebs -url <url>
  84. stsadm -o enumtemplates [-lcid <language>]
  85. stsadm -o enumusers -url <url>
  86. stsadm -o enumwppacks [-name <name of Web Part Package>] [-url <virtual server url>] [-farm]
  87. stsadm -o enumzoneurls -url <protocol://existing.WebApplication.URLdomain> -resourcename <non-web application resource name>
  88. stsadm -o execadmsvcjobs
  89. stsadm -o export -url <URL to be exported> -filename <export file name> [-overwrite] [-includeusersecurity] [-haltonwarning] [-haltonfatalerror] [-nologfile] [-versions <1-4> 1= Last major version for files and list items (default), 2= The current version, either the last major or the last minor, 3= Last major and last minor version for files and list items, 4= All versions for files and list items] [-cabsize <integer from 1-1024 megabytes> (default: 25)] [-nofilecompression] [-quiet]
  90. stsadm -o extendvs -url <url> -ownerlogin <domain\name> -owneremail <email address> [-exclusivelyusentlm] [-ownername <display name>] [-databaseuser <database user>] [-databaseserver <database server>] [-databasename <database name>] [-databasepassword <database user password>] [-lcid <language>] [-sitetemplate <site template>] [-donotcreatesite] [-description <iis web site name>] [-sethostheader] [-apidname <app pool name>] [-apidtype <configurableid/NetworkService>] [-apidlogin <DOMAIN\name>] [-apidpwd <app pool password>] [-allowanonymous]
  91. stsadm -o extendvsinwebfarm -url <url> -vsname <web application name> [-exclusivelyusentlm] [-apidname <app pool name>] [-apidtype <configurableid/NetworkService>] [-apidlogin <DOMAIN\name>] [-apidpwd <app pool password>] [-allowanonymous]
  92. stsadm -o forcedeleteweb -url <url>
  93. stsadm -o formtemplatequiescestatus [-formid <form template ID>] [-filename <path to form template file>]
  94. stsadm -o getadminport
  95. stsadm -o getdataconnectionfileproperty -filename <filename of the data connection file> -pn <property name>
  96. stsadm -o getformsserviceproperty -pn <option name>
  97. stsadm -o getformtemplateproperty [-formid <form template ID>] [-filename <path to form template file>] -pn <property name>
  98. stsadm -o getproperty -propertyname <property name> [-url <url>] (SharePoint cluster properties: avallowdownload, avcleaningenabled, avdownloadscanenabled, avnumberofthreads, avtimeout, avuploadscanenabled, command-line-upgrade-running, database-command-timeout, database-connection-timeout, data-retrieval-services-enabled, data-retrieval-services-oledb-providers, data-retrieval-services-response-size, data-retrieval-services-timeout, data-retrieval-services-update, data-source-controls-enabled, dead-site-auto-delete, dead-site-notify-after, dead-site-num-notifications, defaultcontentdb-password, defaultcontentdb-server, defaultcontentdb-user, delete-web-send-email, irmaddinsenabled, irmrmscertserver, irmrmsenabled, irmrmsusead, job-ceip-datacollection, job-config-refresh, job-database-statistics, job-dead-site-delete, job-usage-analysis, job-watson-trigger, large-file-chunk-size, token-timeout, workflow-cpu-throttle, workflow-eventdelivery-batchsize, workflow-eventdelivery-throttle, workflow-eventdelivery-timeout, workflow-timerjob-cpu-throttle, workitem-eventdelivery-batchsize, workitem-eventdelivery-throttle; SharePoint virtual server properties: alerts-enabled, alerts-limited, alerts-maximum, change-log-expiration-enabled, change-log-retention-period, data-retrieval-services-enabled, data-retrieval-services-inherit, data-retrieval-services-oledb-providers, data-retrieval-services-response-size, data-retrieval-services-timeout, data-retrieval-services-update, data-source-controls-enabled, days-to-show-new-icon, dead-site-auto-delete, dead-site-notify-after, dead-site-num-notifications, defaultquotatemplate, defaulttimezone, delete-web-send-email, job-change-log-expiration, job-dead-site-delete, job-diskquota-warning, job-immediate-alerts, job-recycle-bin-cleanup, job-usage-analysis, job-workflow, job-workflow-autoclean, job-workflow-failover, max-file-post-size, peoplepicker-activedirectorysearchtimeout, peoplepicker-distributionlistsearchdomains, peoplepicker-nowindowsaccountsfornonwindowsauthenticationmode, peoplepicker-onlysearchwithinsitecollection, peoplepicker-searchadcustomquery, peoplepicker-searchadforests, presenceenabled, recycle-bin-cleanup-enabled, recycle-bin-enabled, recycle-bin-retention-period, second-stage-recycle-bin-quota, send-ad-email)
  99. stsadm -o getsitedirectoryscanschedule
  100. stsadm -o getsitelock -url <url>
  101. stsadm -o getsiteuseraccountdirectorypath -url <url>
  102. stsadm -o geturlzone -url <protocol://incoming.url.domain>
  103. stsadm -o grantiis7permission
  104. stsadm -o import -url <URL to import to> -filename <import file name> [-includeusersecurity] [-haltonwarning] [-haltonfatalerror] [-nologfile] [-updateversions <1-3> 1= Add new versions to the current file (default), 2= Overwrite the file and all its versions (delete then insert),3= Ignore the file if it exists on the destination] [-nofilecompression] [-quiet]
  105. stsadm -o installfeature {-filename <relative path to Feature.xml from system feature directory> | -name <feature folder>} [-force]
  106. stsadm -o listlogginglevels [-showhidden]
  107. stsadm -o listregisteredsecuritytrimmers -ssp <ssp name>
  108. stsadm -o localupgradestatus
  109. stsadm -o managepermissionpolicylevel -url <url> -name <permission policy level name> [{ -add | -delete }] [-description <description>] [-siteadmin <true | false>] [-siteauditor <true | false>] [-grantpermissions <comma-separated list of permissions>] [-denypermissions <comma-separated list of permissions>]
  110. stsadm -o mergecontentdbs -url <url> -sourcedatabasename <source database name> -destinationdatabasename <destination datbabase name> [-operation <1-3> 1 - Analyze (default) 2 - Full Database Merge 3 - Read from file] [-filename <file generated from stsadm -o enumsites>]
  111. stsadm -o migrateuser -oldlogin <DOMAIN\name> -newlogin <DOMAIN\name> [-ignoresidhistory]
  112. stsadm -o osearch [-action <list|start|stop>] required parameters for 'start' (if not already set): role, farmcontactemail, service credentials [-f (suppress prompts)] [-role <Index|Query|IndexQuery>] [-farmcontactemail <email>] [-farmperformancelevel <Reduced|PartlyReduced|Maximum>] [-farmserviceaccount <DOMAIN\name> (service credentials)] [-farmservicepassword <password>] [-defaultindexlocation <directory>] [-propagationlocation <directory>] [-cleansearchdatabase <true|false>] [-ssp <ssp name>] required parameter for 'cleansearchdatabase'
  113. stsadm -o osearchdiacriticsensitive -ssp <ssp name> [-setstatus <True|False>] [-noreset] [-force]
  114. stsadm -o preparetomove {-ContentDB <DatabaseServer:DatabaseName> | -Site <URL>} [-OldContentDB <uniqueidentifier>] [-undo]
  115. stsadm -o profilechangelog -title <SSP Name> -daysofhistory <number of days> -generateanniversaries
  116. stsadm -o profiledeletehandler -type <Full Assembly Path>
  117. stsadm -o provisionservice -action <start/stop> -servicetype <servicetype (namespace or assembly qualified name if not SharePoint service)> [-servicename <servicename>]
  118. stsadm -o quiescefarm -maxduration <duration in minutes>
  119. stsadm -o quiescefarmstatus
  120. stsadm -o quiesceformtemplate [-formid <form template ID>] [-filename <path to form template file>] -maxduration <time in minutes>
  121. stsadm -o reconvertallformtemplates
  122. stsadm -o refreshdms -url <url>
  123. stsadm -o refreshsitedms -url <url>
  124. stsadm -o registersecuritytrimmer -ssp <ssp name> -id <0 - 2147483647> -typename <assembly qualified TypeName of ISecurityTrimmer implementation> -rulepath <crawl rule URL> [-configprops <name value pairs delimited by '~'>]
  125. stsadm -o registerwsswriter
  126. stsadm -o removedataconnectionfile -filename <filename to remove>
  127. stsadm -o removedrservice -servicename <data retrieval service name> -setting <data retrieval services setting>
  128. stsadm -o remove-ecsfiletrustedlocation -Ssp <SSP name> -Location <URL|UNC> -LocationType SharePoint|Unc|Http
  129. stsadm -o remove-ecssafedataprovider -Ssp <SSP name> -ID <data provider id> -Type Oledb|Odbc|OdbcDsn
  130. stsadm -o remove-ecstrusteddataconnectionlibrary -Ssp <SSP name> -Location <URL>
  131. stsadm -o remove-ecsuserdefinedfunction -Ssp <SSP name> -Assembly <strong name|file path> -AssemblyLocation GAC|File
  132. stsadm -o removeexemptuseragent -name <user-agent to receive InfoPath files instead of a Web page>
  133. stsadm -o removeformtemplate [-formid <form template ID>] [-filename <path to form template file>]
  134. stsadm -o removesolutiondeploymentlock [-server <server> [-allservers]
  135. stsadm -o renameserver -oldservername <oldServerName> -newservername <newServerName>
  136. stsadm -o renamesite -oldurl <oldUrl> -newurl <newUrl> 
  137. stsadm -o renameweb -url <url> -newname <new subsite name>
  138. stsadm -o restore -url <url> -filename <filename> [-hostheaderwebapplicationurl <web application url>] [-overwrite]
  139. stsadm -o restore -directory <UNC path> -restoremethod <overwrite | new> [-backupid <Id from backuphistory, see stsadm -help backuphistory>] [-item <created path from tree>] [-percentage <integer between 1 and 100>] [-showtree] [-suppressprompt] [-username <username>] [-password <password>] [-newdatabaseserver <new database server name>] [-quiet]
  140. stsadm -o restoressp -title <SSP name> -url <Web application url> -ssplogin <username> -mysiteurl <MySite Web application url> -indexserver <index server> -indexlocation <index file path> [-keepindex] -sspdatabaseserver <SSP database server> -sspdatabasename <SSP database name> [-ssppassword <password>] [-sspsqlauthlogin <SQL username>] [-sspsqlauthpassword <SQL password>] [-searchdatabaseserver <search database server>] [-searchdatabasename <search database name>] [-searchsqlauthlogin <SQL username>] [-searchsqlauthpassword <SQL password>] [-ssl <yes|no>]
  141. stsadm -o retractsolution -name <Solution name> [-url <virtual server url>] [-allcontenturls] [-time <time to remove at>] [-immediate] [-local] [-lcid <language>]
  142. stsadm -o retractwppack -name <Web Part Package name> [-url <virtual server url>] [-time <time to retract at>] [-immediate] [-local] [-lcid <language>]
  143. stsadm -o runcmsmigrationprofile -profilename <profile name> [-skipanalyzer ] [-onlyanalyzer ] [-startover ] [-migratesincetime <DateTime string>] [-migrationfolder <path>] [-exportonly ] [-importonly ] [-htmldiff <path>]
  144. stsadm -o runcontentdeploymentjob -jobname <name> [-wait yes|no] [-deploysincetime <datetime>] (<datetime> as "MM/DD/YY HH:MM:SS")
  145. stsadm -o scanforfeatures [-solutionid <Id of Solution>] [-displayonly]
  146. stsadm -o setadminport -port <port> [-ssl] [-admapcreatenew] [-admapidname <app pool name>]
  147. stsadm -o setapppassword -password <password>
  148. stsadm -o setbulkworkflowtaskprocessingschedule -schedule <recurrence string>
  149. stsadm -o setconfigdb [-connect] -databaseserver <database server> [-databaseuser <database user>] [-databasepassword <database user password>] [-databasename <database name>] [-exclusivelyusentlm] [-farmuser] [-farmpassword] [-adcreation] [-addomain <Active Directory domain>] [-adou <Active Directory OU>]
  150. stsadm -o setcontentdeploymentjobschedule -jobname <name> -schedule <schedule> (Schedule Parameter Examples: "every 5 minutes between 0 and 59", "hourly between 0 and 59", "daily at 15:00:00", "weekly between Fri 22:00:00 and Sun 06:00:00", "monthly at 15 15:00:00", "yearly at Jan 1 15:00:00")
  151. stsadm -o setdataconnectionfileproperty -filename <filename of the data connection file> -pn <property name> -pv <property value>
  152. stsadm -o setdefaultssp -title <SSP name>
  153. stsadm -o set-ecsexternaldata -Ssp <SSP name> [-ConnectionLifetime <time in seconds>] [-UnattendedServiceAccountName <account name>] [-UnattendedServiceAccountPassword <account password>]
  154. stsadm -o set-ecsloadbalancing -Ssp <SSP name> [-Scheme WorkbookUrl|RoundRobin|Local] [-RetryInterval <time in seconds>]
  155. stsadm -o set-ecsmemoryutilization -Ssp <SSP name> [-MaxPrivateBytes <memory in MBytes>] [-MemoryCacheThreshold <percentage>] [-MaxUnusedObjectAge <time in minutes>]
  156. stsadm -o set-ecssecurity -Ssp <SSP name> [-FileAccessMethod UseImpersonation|UseFileAccessAccount] [-AccessModel Delegation|TrustedSubsystem] [-RequireEncryptedUserConnection False|True] [-AllowCrossDomainAccess True|False]
  157. stsadm -o set-ecssessionmanagement -Ssp <SSP name> [-MaxSessionsPerUser <number of sessions>]
  158. stsadm -o set-ecsworkbookcache -Ssp <SSP name> [-Location <local or UNC path>] [-MaxCacheSize <storage in Mbytes>] [-EnableCachingOfUnusedFiles True|False]
  159. stsadm -o setformsserviceproperty -pn <option name> -pv <option value>
  160. stsadm -o setformtemplateproperty [-formid <form template ID>] [-filename <path to form template file>] -pn <property name> -pv <property value>
  161. stsadm -o setholdschedule -schedule <recurrence string>
  162. stsadm -o setlogginglevel [-category < [CategoryName | Manager:CategoryName [;...]] >] {-default | -tracelevel  < None;  Unexpected; Monitorable; High; Medium; Verbose> [-windowslogginglevel < None;  ErrorServiceUnavailable;  ErrorSecurityBreach;  ErrorCritical;  Error;  Warning;  FailureAudit; SuccessAudit;  Information;  Success>] }
  163. stsadm -o setpolicyschedule -schedule <recurrence string>
  164. stsadm -o setproperty -propertyname <property name> -propertyvalue <property value> [-url <url>] (SharePoint cluster properties:, avallowdownload, avcleaningenabled, avdownloadscanenabled, avnumberofthreads, avtimeout, avuploadscanenabled, command-line-upgrade-running, database-command-timeout, database-connection-timeout, data-retrieval-services-enabled, data-retrieval-services-oledb-providers, data-retrieval-services-response-size, data-retrieval-services-timeout, data-retrieval-services-update, data-source-controls-enabled, dead-site-auto-delete, dead-site-notify-after, dead-site-num-notifications, defaultcontentdb-password, defaultcontentdb-server, defaultcontentdb-user, delete-web-send-email, irmaddinsenabled, irmrmscertserver, irmrmsenabled, irmrmsusead, job-ceip-datacollection, job-config-refresh, job-database-statistics, job-dead-site-delete, job-usage-analysis, job-watson-trigger, large-file-chunk-size, token-timeout, workflow-cpu-throttle, workflow-eventdelivery-batchsize, workflow-eventdelivery-throttle, workflow-eventdelivery-timeout, workflow-timerjob-cpu-throttle, workitem-eventdelivery-batchsize, workitem-eventdelivery-throttle; SharePoint virtual server properties:, alerts-enabled, alerts-limited, alerts-maximum, change-log-expiration-enabled, change-log-retention-period, data-retrieval-services-enabled, data-retrieval-services-inherit, data-retrieval-services-oledb-providers, data-retrieval-services-response-size, data-retrieval-services-timeout, data-retrieval-services-update, data-source-controls-enabled, days-to-show-new-icon, dead-site-auto-delete, dead-site-notify-after, dead-site-num-notifications, defaultquotatemplate, defaulttimezone, delete-web-send-email, job-change-log-expiration, job-dead-site-delete, job-diskquota-warning, job-immediate-alerts, job-recycle-bin-cleanup, job-usage-analysis, job-workflow, job-workflow-autoclean, job-workflow-failover, max-file-post-size, peoplepicker-activedirectorysearchtimeout, peoplepicker-distributionlistsearchdomains, peoplepicker-nowindowsaccountsfornonwindowsauthenticationmode, peoplepicker-onlysearchwithinsitecollection, peoplepicker-searchadcustomquery, peoplepicker-searchadforests, presenceenabled, recycle-bin-cleanup-enabled, recycle-bin-enabled, recycle-bin-retention-period, second-stage-recycle-bin-quota, send-ad-email)
  165. stsadm -o setrecordsrepositoryschedule -schedule <recurrence string>
  166. stsadm -o setsearchandprocessschedule -schedule <recurrence string>
  167. stsadm -o setsharedwebserviceauthn -ntlm | -negotiate
  168. stsadm -o setsitedirectoryscanschedule -schedule <recurrence string> (Schedule parameter examples: "every 5 minutes between 0 and 59", "hourly between 0 and 59", "daily at 15:00:00", "weekly between Fri 22:00:00 and Sun 06:00:00", "monthly at 15 15:00:00", "yearly at Jan 1 15:00:00")
  169. stsadm -o setsitelock -url <url> -lock <none | noadditions | readonly | noaccess>
  170. stsadm -o setsiteuseraccountdirectorypath -url <url> [-path <path>]
  171. stsadm -o setsspport -httpport <HTTP port number> -httpsport <HTTPS port number>
  172. stsadm -o setworkflowconfig -url <url> {-emailtonopermissionparticipants <enable|disable> | -externalparticipants <enable|disable> | -userdefinedworkflows <enable|disable>}
  173. stsadm -o siteowner -url <url> [-ownerlogin <DOMAIN\name>] [-secondarylogin <DOMAIN\name>]
  174. stsadm -o spsearch [-action <list | start | stop | attachcontentdatabase | detachcontentdatabase | fullcrawlstart | fullcrawlstop>] [-f (suppress prompts)] [-farmperformancelevel <Reduced | PartlyReduced | Maximum>] [-farmserviceaccount <DOMAIN\name> (service credentials)] [-farmservicepassword <password>] [-farmcontentaccessaccount <DOMAIN\name>] [-farmcontentaccesspassword <password>] [-indexlocation <new index location>] [-databaseserver <server\instance> (default: josebda-moss)] [-databasename <database name> (default: SharePoint_WSS_Search)] [-sqlauthlogin <SQL authenticated database user>] [-sqlauthpassword <password>] -action list -action stop [-f (suppress prompts)] -action start -farmserviceaccount <DOMAIN\name> (service credentials) [-farmservicepassword <password>] -action attachcontentdatabase [-databaseserver <server\instance> (default: josebda-moss)] -databasename <content database name> [-searchserver <search server name> (default: josebda-moss)] -action detachcontentdatabase [-databaseserver <server\instance> (default: josebda-moss)] -databasename <content database name> [-f (suppress prompts)] -action fullcrawlstart -action fullcrawlstop
  175. stsadm -o spsearchdiacriticsensitive [-setstatus <True|False>] [-noreset] [-force]
  176. stsadm -o sync {-ExcludeWebApps <web applications> | -SyncTiming <schedule(M/H/D:value)> | -SweepTiming <schedule(M/H/D:value)> | -ListOldDatabases <days> | -DeleteOldDatabases <days>}
  177. stsadm -o syncsolution -name <Solution name>] [-lcid <language>] [-alllcids]
  178. stsadm -o syncsolution -allsolutions
  179. stsadm -o unextendvs -url <url> [-deletecontent] [-deleteiissites]
  180. stsadm -o uninstallfeature {-filename <relative path to Feature.xml> | -name <feature folder> | -id <feature Id>} [-force]
  181. stsadm -o unquiescefarm
  182. stsadm -o unquiesceformtemplate [-formid <form template ID>] [-filename <path to form template file>]
  183. stsadm -o unregistersecuritytrimmer -ssp <ssp name> -id <0 - 2147483647>
  184. stsadm -o unregisterwsswriter
  185. stsadm -o updateaccountpassword -userlogin <DOMAIN\name> -password <password> [-noadmin]
  186. stsadm -o updatealerttemplates -url <url> [-filename <filename>] [-lcid <language>
  187. stsadm -o updatefarmcredentials [-identitytype <configurableid/NetworkService>] [-userlogin <DOMAIN\name>] [-password <password>] [-local [-keyonly]]
  188. stsadm -o upgrade {-inplace | -sidebyside} [-url <url>] [-forceupgrade] [-quiet] [-farmuser <farm user>] [-farmpassword <farm user password>] [-reghost] [-sitelistpath <sites xml file>]
  189. stsadm -o upgradeformtemplate -filename <path to form template file> [-upgradetype <upgrade type>]
  190. stsadm -o upgradesolution -name <Solution name> -filename <upgrade filename> [-time <time to upgrade at>] [-immediate] [-local] [-allowgacdeployment] [-allowcaspolicies] [-lcid <language>]
  191. stsadm -o upgradetargetwebapplication -url <URL to upgrade> -relocationurl <new URL for non-upgraded content> -apidname <new app pool name> [-apidtype <configurableid/NetworkService>] [-apidlogin <DOMAIN\name>] [-apidpwd <app pool password>] [-exclusivelyusentlm]
  192. stsadm -o uploadformtemplate -filename <path to form template file>
  193. stsadm -o userrole -url <url> -userlogin <DOMAIN\name> -role <role name> [-add] [-delete]
  194. stsadm -o verifyformtemplate -filename <path to form template file>

Friday 21 December 2012

Shredded Storage and the Evolution of SharePoint’s Storage Architecture


SharePoint Portal Server 2001image
SharePoint Portal Server 2001 represented the first commercially available version of SharePoint and utilized a unique, new storage model based on the Web Storage System originally implemented in Exchange Server 2000.  The Web Storage System (ironically WSS) implemented a hierarchical folder model for storing unstructured content (I.e. Word Documents, PowerPoint Presentations, etc.) [see image below] with support for accessing and updating the content through a set of APIs and Internet protocols.
image
The Web Storage System also implemented a store-level event model that supported both synchronous and asynchronous processing in addition to a light-weight workflow engine.
Web Storage System
Definitions
CDO (Collaborative Data Objects)
CDO provides access to Outlook-compatible objects through a COM-based API.  For example, an application can connect to a MAPI store, and then perform operations against that store, including creating and processing calendar items, and resolving and handling mail recipients.
IFS (Installable File System)
The installable file system (IFS) provides access to the Microsoft Web Storage System that SharePoint Portal Server uses.
In SharePoint Portal Server 2001 IFS access is used for:
  • Read-only access to the document library
  • Microsoft FrontPage Server Extensions
  • Web Storage System development through IFS
SMB (Server Message Block)
SMB is an application-layer network protocol commonly used for providing shared access to files, printers, and serial ports.
SharePoint Portal Server 2003image
SharePoint Portal Server 2003 fundamentally changed the semantics of BLOB storage by routing the binary stream associated with a file to one or more SQL Server content databases, which in addition to the file stored individual sites structured data.   Unlike SharePoint Portal Server 2001, SharePoint Portal Server 2003 stored all end-user data in SQL Server databases providing a number of advantages over the Web Storage System such as:
  • Storing list data, documents, and associated metadata in normalized tables
  • Support for transactional updates of documents and document metadata
  • A unified backup solution for documents and document metadata
The Web Storage System supported one database per site and table per list, the new relational database model in SharePoint Portal Server 2003 implemented a fixed database schema and number of databases per server to enable more effective horizontal scaling capabilities.
The primary storage tables in SharePoint Portal Server 2003 included the Sites, Docs, Lists, Links, and WebParts tables.
dbSchema
dbo.Sites
In SharePoint Portal Server 2003 the Sites table stored settings that apply to individual site collections representing the top-level site of each site collection including the root site and My Site as related to the portal site.  Subordinate objects such as Webs and their corresponding settings were stored in the Webs tables.
dbo.Docs
The Docs table stored all documents within their respective site collections such  as documents in document libraries, attachment, list nodes, and customized users pages.
The Content column in Docs was defined to store unstructured content generated by users and was based on the image data type.  The image data type, removed in future versions of SQL Server, was a variable-length binary data from 0 through 2^31-1 (2,147,483,647) bytes (I.e. 2GB).
dbo.Lists
The Lists table contained a row for each list of all the sites in the database. This table contained settings for each list, specifying which lists or document libraries were included in the sites.
dbo.Links
The Links table contained links used in link fix-up to recalculate links.
dbo.Web Parts
The Web Parts table contained information about all the Web Parts and list views used in the sites.  Web Part personalization information were maintained in the Personalization table.
SharePoint Portal Server 2003 used foreign key relationships into tables and added two additional databases, the Profile and Services databases. The Profile database stored personal profiles and audience definitions for targeting of Web Parts and content, and the Services database supported search and indexing as well as subscriptions and subscription results.
Office SharePoint Server 2007image
Office SharePoint Server 2007 carried forward the relational database storage model with notable exceptions including changes to the content database schema as related to the storage of unstructured content.
External BLOB Storage
Office SharePoint Server 2007 introduced new methods to support the externalization of user content (BLOBs) or unstructured data through External BLOB Storage.  External BLOB Storage in Office SharePoint Server 2007 ran in parallel to SharePoint's content databases enabling unstructured content to reside on alternate data stores with the structured content, such as site data, residing within the content database(s).  To coordinate the separate data stores a COM interface was necessary and was implemented servers where Office SharePoint Server 2007 was installed and used basic semantics to recognize save and open commands that invoked redirection to BLOB storage in the event a BLOB data stream required updating.  The implemented COM interface in External BLOB Storage is referred to as a provider (ISPExternalBinaryProvider) which was installed and registered on each Web server.
EBS
SharePoint Server 2010image
SharePoint Server 2010 maintained the relational database storage model and further modified content database schema in addition to adding support for new BLOB externalization support solutions.
External BLOB Storage
SharePoint Server 2010 continued to provide support for External BLOB Storage; however, was deprecated in favor of new a unstructured data storage solution, Remote BLOB Storage.
Remote BLOB Storage
In response to deprecating support for External BLOB Storage, SharePoint Server 2010 introduced support for Remote BLOB Storage that leveraged built-in SQL Server 2008 capabilities.  Remote BLOB Storage is a SQL Server library API set that is provided as an add-on feature pack for SQL Server 2008 R2, SQL Server 2008 or SQL Server 2008 R2 Express.  Remote BLOB Storage provides two separate solutions, a FILESTREAM provider that enables basic storage of unstructured content on either the file system of a local or remote database server and an interface to allow 3rd party vendors to develop providers for the externalization of unstructured data through Remote BLOB Storage.
Functionally and at its most basic Remote BLOB Storage provides a similar solution to handling unstructured data as External BLOB Storage; however, supports new levels of overall granularity.  Whereas External BLOB Storage was a COM-based farm level implementation, Remote BLOB Storage is a .NET-based database level implementation meaning it can be implemented for a certain subset of content, but not other content.  With Remote BLOB Storage SQL Server and SharePoint Server 2010 jointly manage the data integrity between the database records and contents of the RBS external store on a per-database basis.
For additional information about Remote BLOB Storage and FILESTREAM in addition to more resources see also http://blogs.technet.com/b/wbaer/archive/2011/02/22/filestream-and-sharepoint-2010.aspx.
SharePoint Server 2013image
SharePoint Server 2013 maintains the relational database storage model for unstructured content and while improving IO efficiency.  Support for External BLOB Storage is removed in SharePoint Server 2013 while support for Remote BLOB Storage is retained.
Shredded Storage
SharePoint Server 2013 provides an improved level of IO and storage efficiency through a new storage capability known as Shredded Storage.
Shredded storage is a new data platform improvement in SharePoint 2013 related to the management of large binary objects (I.e. BLOBS such as PowerPoint Presentations, Word Documents, etc.).
Shredded Storage both improves I/O and reduces compute utilization when making incremental changes to document or storing documents in SharePoint 2013. Shredded Storage builds upon the Cobalt (I.e. File Synchronization via SOAP of HTTP) protocol introduced in SharePoint 2010.
In SharePoint Server 2010 dbo.AllDocStreams stored the document stream and related data for documents with content streams, in SharePoint Server 2013 dbo.DocStreams replaces dbo.AllDocStreams where each row stores a portion of the BLOB.  New dbo.DocToStreams contains rows which correspond to those in dbo.DocStreams (read more below).
Notable SharePoint Server 2013 Schema Changes
  • dbo.AllDocStreams has been renamed to dbo.DocStreams.  Each row in dbo.DocStreams stores a chunk or portion of the BLOB.
  • A new DocToStreams table contains a pointer to a corresponding row in dbo.DocStreams.  The BLOB Sequence Number (BSN) is used to manage the BLOB sequence across dbo.AllDocVersions, dbo.DocsToStreams, and dbo.DocStreams.  NextBSN is used to manage the last BSN for each BLOB.
  • The BLOB access pattern is dbo.AllDocs/dbo.AllDocVersions > dbo.DocsToStreams > dbo.DocStreams.
File Storage Semantics
  • dbo.AllDocs contains a single row per file similar to SharePoint Server 2010.
  • dbo.AllDocVersions contains one or more rows per file and one row per file version.
  • dbo.DocsToStreams contains a number of rows that correspond to the number of BLOBs associated with the file.  Each row in dbo.DocsToStreams corresponds to a row in dbo.DocStreams based on the BSN which has the associated BLOB in the Content column (see Notable SharePoint Server 2013 Schema Changes)
Shredded Storage Frequently Asked Questions
Q:  Can I disable Shredded Storage?
A:  No, Shredded Storage is enabled by default and cannot be disabled.
Q:  Does Shredded Storage work with Remote BLOB Storage (RBS)?
A:  Yes, Shredded Storage works with Remote BLOB Storage.
Q:  Can I prevent a file from being shredded?
A:  Yes and no.  In the event shredding is not desired the FileWriteChunkSize property can be set to the MaxFileSize of 2GB resulting in a monolithic file; however, modifying the FileWriteChunkSize property can adversely affect latency and performance.