Web Deploy Provider Settings

Applies To: Windows 7, Windows Server 2003, Windows Server 2003 R2, Windows Server 2008, Windows Server 2008 R2, Windows Vista, Windows XP

Providers can be optionally modified by using provider settings. Provider settings can be added to either a source or a destination by using the general syntax

,ProviderSettingName=ProviderSettingValue

For example, in the following sync operation, the provider setting computerName=Server1 is used with the metaKey provider to specify that the source lm/w3svc/1 is found on the computer named Server1.

msdeploy.exe -verb:sync -source:metakey=lm/w3svc/1,computerName=Server1 -dest:metakey=lm/w3svc/2

Important

There is no space between the comma and the provider setting.

Provider Settings List

The following lists common Web Deploy provider settings.

Important

Setting

Example

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

Note

Setting

Example

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

Important

Setting

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

Note

Setting

Example

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

Note

Setting

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

Note

Setting

Example

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

Note

Setting

Example

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

Important

Setting

Example

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

computername=Server1,username=AdminX,password=WebDeploy

Note

Setting

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

For the dbFullSql provider settings, see Web Deploy dbFullSql Provider. For the dbMySql provider settings, see Web Deploy dbMySql Provider. For the iisAppskipAppCreation provider setting, see Web Deploy iisApp Provider. For the metaKey provider settings, see Web Deploy metaKey Provider.

See Also

Web Deploy archiveDir Provider

Web Deploy Command Line Reference

Web Deploy contentPath Provider

Web Deploy package Provider

Web Deploy Providers