Command-Line Properties

This topic lists and explains the properties that can be set on the command line by using the Stsadm.exe tool with the getproperty and setproperty operations. To see the current value of a property, you use the getproperty operation. To set the value for a property, you use the setproperty operation. The following examples show the syntax to use when getting or setting a property:

stsadm.exe -o getproperty -pn <property name> [-url <url>]
stsadm.exe -o setproperty -pn <property name> -pv <property value> [-url <url>]

Some properties are available for the entire server, and are called server properties. Some are only available for an individual virtual server. When you get or set a server property, you can omit the url parameter. You must include the url parameter to get or set virtual server properties. For more information about setting properties, see "Introducing the Administration Tools for Windows SharePoint Services" in the Windows SharePoint Services Administrator's Guide.

Server Properties for Windows SharePoint Services

Virtual Server Properties for Windows SharePoint Services

Alert Properties

Use these properties to configure alerts for your server. The alerts-enabled, alerts-limited, and alerts-maximum properties can be set at either the server (and server farm) or virtual server level. Use the -url parameter to configure these properties for a specific virtual server or omit it to configure these properties for an entire server. The job-daily-alerts, job-immediate-alerts, and job-weekly-alerts properties properties can be set only at the virtual server level. You must specify the -url parameter when you configure these properties. For more information about alerts, see Managing Alerts.

Property name Description Values
alerts-enabled Specifies whether alerts are enabled for this virtual server "true" or "false"
alerts-limited Specifies whether users are limited as to the number of alerts they can create "true" or "false"
alerts-maximum If alerts-limited is configured, specifies the maximum number of alerts that users can create A numerical value
job-daily-alerts Specifies the time to send out daily alerts A phrase that includes the frequency interval and time range to send out notifications. For example "daily between 22:00:00 and 06:00:00".
job-immediate-alerts Specifies how long to wait before sending out daily alerts A phrase that includes the frequency interval and time range to send out notifications. For example "every 5 minutes between 0 and 59".
job-weekly-alerts Specifies the day and time to send out weekly alerts A phrase that includes the frequency interval and time range to send out notifications. For example "weekly between Fri 22:00:00 and Mon 06:00:00".

Antivirus Properties

Use these properties to configure antivirus protection for your server. These properties can be set only at the server (and server farm) level. You do not need to specify the -url parameter when you configure these properties. For more information about using antivirus scanning, see Configuring Antivirus Protection.

Property name Description Values
avallowdownload Specifies whether users can download infected files to their client computers "yes" or "no"
avcleaningenabled Specifies whether antivirus cleaning is enabled "yes" or "no"
avdownloadscanenabled Specifies whether the download scans are enabled "yes" or "no"
avnumberofthreads Specifies the number of threads to take up with antivirus processes A numerical value, the number of threads to use
avtimeout Specifies the timeout time for scanning A numerical value, in seconds
avuploadscanenabled Specifies whether the upload scans are enabled "yes" or "no"

Content Database Properties

Use these properties to set the server name, user name, and password to use for the default content database for your server. These properties can be set only at the server (and server farm) level. You do not need to specify the -url parameter when you configure these properties. For more information about the default content database, see content databases (content database: The Microsoft SQL Server or WMSDE database that contains the content for one or more SharePoint sites.).

Property name Description Values
defaultcontentdb-password Specifies the password for the defaultcontentdb-user A password
defaultcontentdb-server Specifies the server that contains the default content database A server name
defaultcontentdb-user Specifies the username for the default content database A user account in the format DOMAIN\username

Data Retrieval Services Properties

Use these properties to configure data retrieval services for your virtual server, server, or server farm. These properties can be set at either the server or virtual server level. Use the -url parameter to configure these properties for a specific virtual server or omit it to configure these properties for an entire server. For more information about data retrieval services, see Configuring Data Retrieval Services.

Property name Description Values
data-retrieval-services-enabled Specifies whether data retrieval services are enabled "true" or "false"
data-retrieval-services-enabled-list The list of services to which the data-retrieval-services-enabled setting applies A list of services, such as "OLEDB;SOAP Passthrough"
data-retrieval-services-inherit Specifies whether to inherit the server farm settings for a virtual server "true" or "false"
data-retrieval-services-response-size Specifies the maximum size for data returned from the back-end source An integer value in kilobytes (KB) between 1 and 100,000
data-retrieval-services-response-size-list The list of services to which the data-retrieval-services-response-size setting applies A list of services, such as "OLEDB"
data-retrieval-services-timeout Specifies the time an adapter will wait for a response from the back-end data source An integer value in seconds between 1 and 100,000
data-retrieval-services-timeout-list The list of services to which the data-retrieval-services-timeout setting applies A list of services, such as "OLEDB"
data-retrieval-services-update Specifies whether adapters can execute requests that contain updatable queries "true" or "false"
data-retrieval-services-update-list The list of services to which the data-retrieval-services-update setting applies A list of services, such as "OLEDB"
data-retrieval-services-oledb-providers Specifies the list of supported OLEDB providers

The list of OLEDB providers, separated by semi-colons

For example: "DB2OLEDB;IBMDADB2;MSDAORA;OraOLEDB.Oracle;SQLOLEDB"

General Virtual Server Properties

Use the following properties to specify general settings for a virtual server. These properties can be set only at the virtual server level. You must specify the -url parameter when you configure these properties. For more information about specifying virtual server general settings, see Configuring Virtual Servers. For more information about large-file-chunk-size, see Configuring large file support in Installing and Using Service Packs for Windows SharePoint Services.

Property name Description Values
days-to-show-new-icon Specifies how long (in days) to display the New icon for items added to a Web site A numerical value (number of days)
defaultquotatemplate Specifies the default quota template for Web sites A quota template name
defaulttimezone Specifies the default time zone for Web sites A time zone (numerical). For a list of valid time zones, see Regional and Language Settings.
large-file-chunk-size Specifies the chunk size to use for large files A numerical value, in megabytes (MB). The default value is 5 MB.
max-file-post-size Specifies the maximum size for files posted to Web sites A numerical value, in megabytes (MB). The default value is 50 MB.

General Server Properties

Use these properties to specify settings for your server. These properties can be set only at the server (and server farm) level. You do not need to specify the -url parameter when you configure these properties. For more information about changing IIS application pool identities, see Changing the Application Pool Identity for a Virtual Server. For more information about user account modes, see Installation Considerations for Windows SharePoint Services. For more information about full-text search, see Managing and Customizing Search.

Property name Description Values
adminportidentity

Contains the IIS Application Pool identity that is being used for the SharePoint Central Administration port.

You can only use the "getproperty" operation with this property - it cannot be set through the command line. To set this property, you must change the IIS Application Pool identity in IIS.

The IIS Application Pool identity that the Central Administration port is running under
fulltextsearchenabled Specifies whether full text searching and indexing is enabled "1" (yes) or "0" (no)

HTML Viewer Properties

Use these properties to specify HTML Viewer options for your server or server farm. These properties can be set only at the server (and server farm) level. You do not need to specify the -url parameter when you configure these properties. For more information about HTML viewing, see Managing HTML Viewers.

Property name Description Values
htmltranslbpath Specifies the path (URL) to the HTML Viewer server A URL
htmltransmaxcachesize Specifies the maximum cache size for the HTML Viewer A numerical value, in MB
htmltransmaxsize Specifies the maximum file size that can be viewed A numerical value, in MB
htmltranson Specifies whether HTML viewing is enabled "true" or "false"
htmltranstimeout Specifies the timeout time for HTML viewing A numerical value, in seconds

Security Properties

Use these properties to set security policies for Self-Service Site Creation, user names and passwords, and security validation, and to get the virtualserverpermsmask property.

Some of these properties can be set only at the virtual server level. You must specify the -url parameter when you configure these properties. For more information about Self-Service Site Creation, see Configuring Self-Service Site Creation.

Property name Description Values
createadaccounts

Contains a value specifying which user account mode has been configured. "Yes" indicates that you are in Active Directory account creation mode, "no" indicates that you are in domain account mode.

You can only use the "getproperty" operation with this property - it cannot be set through the command line. This property is set when you install Windows SharePoint Services and choose a user account mode.

This property is only available at the server level and does not take the -url parameter.

"yes" or "no"
ssc

Specifies whether to allow Self-Service Site Creation.

This property can only be set at the virtual server level and requires the -url parameter.

"yes" or "no"
ssc-contact

Specifies whether or not to require a secondary contact for sites created by using Self-Service Site Creation.

This property can only be set at the virtual server level and requires the -url parameter.

"yes" or "no"
adaccountdomain

Specifies the Active Directory domain name to use for user accounts in Active Directory account creation mode.

This property can only be set at the server level and does not take the -url parameter.

A domain name
adaccountou

Specifies the organizational unit to use for user accounts in Active Directory account creation mode.

This property can only be set at the server level and does not take the -url parameter.

An organizational unit name
send-ad-email

Specifies whether or not to send usernames and passwords through e-mail.

This property can only be set at the virtual server level and requires the -url parameter.

"true" or "false"
securityvalidation-enabled

Specifies whether security credentials must be validated again before an operation that has timed out can be run again.

This property can only be set at the virtual server level and requires the -url parameter.

"true" or "false"
securityvalidation-expire

Specifies whether Web Page Security Validation is set to never expire.

This property can only be set at the virtual server level and requires the -url parameter.

"true" or "false"
securityvalidation-timeout

Specifies how long (in minutes) to wait before requiring security validation for a timed-out operation.

This property can only be set at the virtual server level and requires the -url parameter.

A number (minutes to wait)
virtualserverpermsmask

Contains a value that indicates what changes have been made to the list of user rights available for use on a virtual server with the virtualserverpermsmask property.

You can only use the "getproperty" operation with this property - it cannot be set through the command line. This property is set when you make changes to the Manage User Rights for Virtual Server page in SharePoint Central Administration.

This property is only available at the virtual server level and requires the -url parameter.

For more information about configuring the list of user rights available for use on a virtual server, see Controlling User Rights and Assigning Tasks.

A hashed number

Site Confirmation and Automatic Deletion Properties

These properties can be set either at the server (and server farm) level or at the virtual server level. Use the -url parameter to configure these properties for a specific virtual server or omit it to configure these properties for an entire server. For more information about site confirmation and automatic deletion, see Managing Unused Web Sites.

Property name Description Values
delete-web-send-email Specifies whether to send e-mail notifications about unused Web sites "yes" or "no"
dead-site-notify-after Specifies how long to wait before sending the first e-mail notification A numerical value (the number of days to wait before sending notifications)
dead-site-num-notifications Specifies how many e-mail notifications to send A numerical value (the number of notifications to send)
dead-site-auto-delete Specifies whether to automatically delete unused Web sites "yes" or "no"
job-dead-site-delete Specifies when to delete unused Web sites automatically A phrase that includes the frequency interval and time range to delete unused Web sites automatically. For example "weekly at Sat 0:00:00".

Usage Analysis Properties

This property can be set either at the server (and server farm) level or at the virtual server level. Use the -url parameter to configure these properties for a specific virtual server or omit it to configure these properties for an entire server. For more information about usage analysis, see Configuring Usage Analysis.

Property name Description Values
job-usage-analysis Specifies the frequency (daily, weekly, monthly) and time of day to perform the usage analysis processes. A phrase that includes the frequency interval and time range to perform usage analysis log processing. For example "daily between 16:55:00 and 17:00:00".

If you want the job to start at a specific time, set the beginning and end times to the same time, for example: "daily between 16:55:21 and 16:55:21".

 Note   This property can be set only to "daily", not to "weekly" or "immediate".

If you want to view the current setting for the job-usage-analysis property, you must include the URL parameter. For example, to see the current usage analysis setting for the default Web site, use the following syntax:

stsadm.exe -o getproperty -pn job-usage-analysis -url http://localhost

Web Part Configuration Properties

Use these properties to configure Web Part settings. These properties can be set only at the virtual server level. You must specify the -url parameter when you configure these properties. For more information about configuring Web Part settings, see About Web Parts and Managing Web Parts on Virtual Servers.

Property name Description Values
spallowglobalcatalog Specifies whether users can use the online Web Part gallery "1" or "0"
spallowsp2p Specifies whether users can connect Web Parts (pass data or values from a source Web Part to a target Web Part) "1" or "0"
 
 
Applies to:
Deployment Center 2003