Proxy Command (TFSConfig)
You can use the TFSConfig Proxy command to update or change the settings used by Team Foundation Server Proxy. Team Foundation Server Proxy provides support for distributed teams to use version control by managing a cache of downloaded version control files in the location of the distributed team. By configuring Team Foundation Server Proxy, you can significantly reduce the bandwidth needed across wide area connections. In addition, you do not have to manage downloading and caching of version files; management of the files is transparent to the developer who is using the files. Meanwhile, any metadata exchanges and file uploads continue to appear in Team Foundation Server (TFS). If you use the Team Foundation Service to host your development project in the cloud, you can use the Proxy command to not only manage the cache for projects in the hosted collection, but also to manage some of the settings used by that service.
For more information about installing Team Foundation Server Proxy and initial configuration of the proxy, see How to: Install Team Foundation Proxy and Set Up a Remote Site. For more information about configuring proxy on client computers, see Team Foundation Version Control Command Reference.
Requirements
To use the Proxy command, you must be a member of the Team Foundation Administrators security group and an administrator on the proxy server. For more information, see Team Foundation Server Permissions.
Using TFSConfig Proxy
TFSConfig Proxy /add|delete|change [/Collection:TeamProjectCollectionURL /account:AccountName] /Server:TeamFoundationServerURL [/Continue]
Argument |
Description |
|---|---|
TeamProjectCollectionURL |
Used with /Collection. Specifies the URL of the team project collection that is hosted on the Team Foundation Service, in AccountName.DomainName/CollectionName format. |
AccountName |
Used with /Collection. Specifies the name of the account that is used as the service account for Team Foundation Service. If the account name has spaces, the name must be enclosed within quotation marks (""). All special characters in account names must be specified in accordance with command-line syntax. |
ServerURL |
Used with /Server. Specifies the URL of a TFS deployment, in ServerURL:Port/tfs format. |
Option |
Description |
|---|---|
/add |
Adds the specified server or collection to the proxy list in the Proxy.config file. You can run /add multiple times to include more collections or servers. When using /add with a collection hosted in Team Foundation Service, you will be prompted for your credentials in Team Foundation Service. |
/change |
Changes the credentials stored as the service account for Team Foundation Service. The /change option is only used for Team Foundation Service; it should not be used for local deployments of TFS. |
/delete |
Removes the specified server or collection from the proxy list in the Proxy.config file. |
/account |
Specifies the account used as the service account for the proxy in Team Foundation Service. This option is only used for Team Foundation Service in conjunction with the /change option. The default service account used for Team Foundation Service is "Account Service." |
/continue |
Continues the execution of the command even if the verification process produces warnings. |
Remarks
You use the Proxy command to update the existing configuration of Team Foundation Server Proxy. You cannot use the Proxy command for initial installation and configuration of the proxy.
Example
The following example shows how to add a TFS deployment named FABRIKAM to the proxy list.
Note
Examples are for illustration only and are fictitious. No real association is intended or inferred.
TFSConfig Proxy /add /Server:http://www.fabrikam.com:8080/tfs
The following example shows how to add a team project collection hosted on Team Foundation Service to the proxy list. The collection is named PhoneSaver and the account name used for Team Foundation Service is HelenaPetersen.fabrikam.com. Because the /account option is not specified, the default service account will be used.
TFSConfig Proxy /add /Collection:https://HelenaPetersen.tfs.visualstudio.com/PhoneSaver
The following example shows how to change the service account used by the proxy for the team project collection hosted on Team Foundation Service. The collection is named PhoneSaver, the account name used for Team Foundation Service is HelenaPetersen.fabrikam.com, and the service account used by the proxy is being changed to "My Proxy Service Account". Because the account name contains spaces, quotation marks are used to enclose the name.
TFSConfig Proxy /change /Collection:https://HelenaPetersen.tfs.visualstudio.com/PhoneSaver /account:"My Proxy Service Account"
See Also
Concepts
How to: Install Team Foundation Proxy and Set Up a Remote Site