Web Deploy Provider Settings

Setting

authType

Usage

,authType=<authenticationType>

Description

<authenticationType> specifies the type of authentication to be used. The possible values are NTLM and Basic. If the wmsvc provider setting is specified, the default authentication type is Basic; otherwise, the default authentication type is NTLM.

Important
You cannot use Basic authentication together with the remote agent service. If you want to use Basic authentication, you can use the Web Management Service (WMSvc). To do this, use the wmsvc provider setting where you would use the computerName setting, as in the following example.

Example

msdeploy -verb:sync -source:webServer,wmsvc=Server1,username=User1,password=1234,authtype=basic -dest:webServer,wmsvc=Server2,username=User2,password=4321,authtype=basic

Setting

computerName

Usage

,computerName=<host>

Description

<host> specifies the name of a remote Web server or proxy URL. The computer name will be translated to the default Web Deploy URL. For example, computerName=Server1 will become http://Server1/MsDeployAgentService. If the remote service is running with a custom port or URL, you must specify the full URL.

Note
The Web Deployment Tool does not perform local impersonation. If you provide values for the username and password provider settings but do not specify the name of a remote computer for the computerName setting, the credentials that you provide will have no effect.

Example

msdeploy -verb:dump -source:metakey=lm/w3svc/1,computerName=Server1

Setting

encryptPassword

Usage

,encryptPassword=<password>

Description

The encryptPassword setting specifies a password to control access to encrypted properties in IIS configuration (for example, an application pool). <password> specifies an alphanumeric password.

During an operation, Web Deploy automatically detects if encrypted objects are present in server-level configuration files (for example, the Applicationhost.config and Machine.config files), and will expect a password to have been specified by the encryptPassword provider setting on the command line. If you do not specify a valid value when a password is required, the operation will fail.

In a dump operation, ,encryptPassword=<password> must be added to the provider specified by the source argument. In a sync operation that uses the archiveDir or package providers, encryptPassword=<password> is added to the archiveDir or package argument. This will encrypt the properties to the archive or package when the archive or package is the destination, and decrypt properties from the archive or package when the archive or package is the source.

Important
Web Deploy does not check Web.config files for encrypted objects. For information about encrypting and decrypting Web.config files by using the ASP.NET IIS Registration Tool, see Encrypting and Decrypting Configuration Sections.

Example

1. Archive the metabase and specify an encrypt password.

msdeploy -verb:sync -source:metaKey -dest:archivedir=c:\mydir,encryptPassword=MyPassKey

2. Display the archive. The passwords will show in encrypted form.

msdeploy -verb:dump -source:archivedir=c:\mydir

3. Use the password that you specified earlier to display the archive. The passwords will show in plain text.

msdeploy -verb:dump -source:archivedir=c:\mydir,encryptPassword=MyPassKey

Setting

getCredentials

Usage

,getCredentials=<target>

Description

<target> is a variable that identifies, in the Windows Credential Manager, a set of credentials (username and password) that will be used when you connect to a remote computer. By using the getCredentials provider setting, you can avoid placing a username and password directly in a command line. To create a <target> variable, use the storeCredentials provider setting to associate a set of credentials with the variable name that you specify.

Note
This provider setting is available only in version 1.1 of the Web Deployment Tool.

Example

msdeploy.exe –verb:dump –source:webserver60,computername=RemoteServer1,getCredentials=mytarget

Setting

ignoreErrors

Note
The ignoreErrors feature is not available in the Release Candidate (RC) version of the Web Deployment Tool.

Usages

[dirPath | filePath]=<path>,ignoreErrors=<ErrorNumber>[;<ErrorNumber>;…]

contentPath=<path>,[dirPath | filePath].ignoreErrors=<ErrorNumber>[;<ErrorNumber>;…]

Description

Specifies a semicolon-delimited list of file system error codes that will be ignored. This provider setting can be used with the dirPath and filePath providers. For more information, see Web Deploy dirPath Provider and Web Deploy filePath Provider.

Example

msdeploy -verb:sync -source:filePath=c:\OriginSite\default.html -dest:filePath=c:\NewSite\default.html,ignoreErrors=8000020

Setting

includeAcls

Usage

,includeAcls=<BOOL>

Description

<BOOL> must be true or false. True if ACLs on the specified path will be included in a dump or sync operation; otherwise, false. This setting applies to the file system, registry, and metabase. This setting is used with these providers: appHostConfig, comObject32, comObject64, contentPath, dirPath, filePath, iisApp, metaKey, webServer, and webServer60. The default is false.

The includeAcls setting is useful in server environments when you want to copy all of the ACLs of the files in a sync operation and have domain users or built-in IIS accounts. Local user accounts are not supported.

Example

msdeploy -verb:sync -source:contentPath=c:\inetpub\wwwroot\special.htm,includeAcls=true -dest:contentPath=c:\inetpub\wwwroot\special.htm,computername=server1

Setting

password

Usage

,password=<password>

Description

<password> specifies a password for the user name. This setting is required if you use Basic authentication.

Note
The Web Deployment Tool does not perform local impersonation. If you provide values for the username and password provider settings but do not specify the name of a remote computer for the computerName setting, the credentials that you provide will have no effect.

Example

msdeploy -verb:sync -source:metakey=lm/w3svc/1,computerName=Server1,userName=administrator,password=MyPassword -dest:metakey=lm/w3svc/2

Setting

storeCredentials

Usage

,storeCredentials=<target>,userName=<username>,password=<password>

Description

<target> is a user-specified variable that identifies, in the Windows Credential Manager, a set of credentials (username and password) that will later be used when you connect to a remote computer. storeCredentials must be used with the username and password provider settings. After you have stored the credentials, you can retrieve them by using the getCredentials provider setting. This lets you avoid placing a username and password directly in a command line.

Note
This provider setting is available only in version 1.1 of the Web Deployment Tool.

Example

msdeploy.exe -verb:dump -source:webServer60,computername=Server1,storecredentials=mytarget,username=administrator,password=password

Setting

tempAgent

Usage

,tempAgent=<BOOL>

Description

<BOOL> must be true or false. True if the remote agent will be temporarily installed for the duration of a remote synchronization operation; otherwise, false. The default is false. This setting is useful if you do not want to install the remote agent service for synchronization purposes on every computer in your environment. When you set tempAgent to true in a sync operation, Web Deploy copies temporary program binaries to admin shares and uses WMI to install a GUID-based URL registration at the directory location %windir%\temp\msdeploy\<GUID>. After the synchronization completes, these temporary files are removed. For more information about the tempAgent provider setting, see Web Deploy On Demand.

Important
To use the tempAgent provider setting, you must running as a user that has administrative privileges on the remote computer. Use of the tempAgent provider setting is not supported when the Web Deploy remote service is already installed.

Example

msdeploy -verb:dump -source:contentPath="c:\temp",tempagent=true,

computername=Server1,username=AdminX,password=WebDeploy

Setting

userName

Usage

,userName=<username>

Description

<username> specifies a user name to be authenticated by the remote computer. This setting is required if you use Basic authentication.

Note
The Web Deployment Tool l does not perform local impersonation. If you provide values for the username and password provider settings but do not specify the name of a remote computer for the computerName setting, the credentials that you provide will have no effect.

Example

msdeploy -verb:dump -source:metakey=lm/w3svc/1,computerName=Server1,userName=administrator

Setting

wmsvc

Usage

,wmsvc=<name>

Description

<name> specifies the name of a remote computer or proxy URL whose IIS Web Management Service (wmsvc) will be used over HTTPS. It is assumed that the service is listening on port 8172.

Example

msdeploy -verb:dump -source:apphostconfig="Site1",wmsvc=Server1,userName=administrator