TFSLabConfig Permissions Command

Article
04/20/2015

Use the TFSLabConfig Permissions command to set and get permissions set for a specified user or for multiple users on a specified object in Visual Studio Lab Management. For more information about individual permissions, see the Lab Management Permissions section of Permission reference for Team Foundation Server.

Required Permissions

To query permissions on an object, you must have Read permissions for the object. To change permissions on an object the Permissions command, you must have the Manage Permissions permission. By default, the creator of the object has this permission. For more information, see Permission reference for Team Foundation Server.

TFSLabConfig Permissions
      /Collection:collectionUrl
      [objectSpec]
      {[/User:userName1[,userName2][,...]]
      [/Group:groupName1[,groupName2][,...]]}
      [/Allow:{* |perm1[,perm2][,...] }] 
      [/Deny:{* |perm1[,perm2][,...]}]
      [/Remove:{* |perm1[,perm2][,...]}]
      [/Inherit:Yes|No]

Parameters

Option	Description
Collection:collectionUrl	Required. The URL of the team project collection on the application tier of Team Foundation Server. For example, /collection:http://abc:8080/TFS/DefaultCollection.
objectSpec	Optional. Specifies the target object such as a team project or library share to which the permissions are applied. For information about how to specify objects, see objectSpec below.
User:userName1[,userName2][,...]	Optional. Specifies one or more users to which the permissions are applied. Use commas to separate multiple user names.
Group:groupName1[,groupName2][,...]	Optional. Specifies one or more groups to which the permissions are applied. Use commas to separate multiple group names.
Allow:{* \|perm1[,perm2][,...]}	Optional. Enables the specified permissions for the specified users or groups. Use an asterisk () to specify all permissions. To specify an individual permission, use the identifiers in the Name at command line* column of the table in the Lab Management Permissions section of Permission reference for Team Foundation Server. Use commas to separate multiple permissions.
Deny:{* \|perm1[,perm2][,...]}	Optional. Denies the specified permissions for the specified users or groups. Use an asterisk () to specify all permissions. To specify an individual permission, use the identifiers in the Name at command line* column of the table in the Lab Management Permissions section of Permission reference for Team Foundation Server. Use commas to separate multiple permissions.
Remove:{* \|perm1[,perm2][,...]}	Optional. Unsets the specified permissions that were previously granted or denied to the user or group. To specify an individual permission, use the identifiers in the Name at command line column of the table in the Lab Management Permissions section of Permission reference for Team Foundation Server. Use commas to separate multiple permissions.
Inherit:Yes\|No	Optional. If you specify Yes, all permissions associated with a parent ACL are inherited by an item. Cannot be combined with the /remove, /user, or /group options.

objectSpec

You can specify the objects that you want to include in the TFSLabConfig Permissions command in two ways:

Use one or more locations options to specify the object in the Lab Management hierarchy.
Use the /Url option to specify the object as a Uri.

If the objectSpec parameter option is not specified, the permissions are applied to all objects in the team project collection.

Object type options

The following table lists the valid combination of options that you can use to specify an object as the objectSpec parameter of a TFSLabConfig permissions command.

To set permissions on	Use these options
A specific host group in a team project collection	/TeamProjectCollectionHostGroup:teamProjectCollectionHostGroupName
A specific library share in a team project collection	/TeamProjectCollectionLibraryShare:teamProjectCollectionLibraryShareName
All group hosts in a team project	/TeamProject:projectName/TeamProjectHostGroup:*
A group host in a team project	/TeamProject:projectName/TeamProjectHostGroup:teamProjectHostGroupName
A lab environment in a host group for a team project	/TeamProject:projectName /TeamProjectHostGroup:teamProjectHostGroupName/LabEnvironment:labEnvironmentName
All library shares in a team project	/TeamProject:projectName/TeamProjectLibraryShare:*
A library share in a team project	/TeamProject:projectName/TeamProjectLibraryShare:teamProjectLibraryShareName
A lab template in a library share of a team project	/TeamProject:projectName /TeamProjectLibraryShare:teamProjectLibraryShareName /LabTemplate:labTemplateName
A lab environment in a library share of a team project	/TeamProject:projectName /TeamProjectLibraryShare:teamProjectLibraryShareName /LabEnvironment:labEnvironmentName

Url

Use the following syntax to specify the objectSpec target object of a TFSLabConfig permissions command by using the /Url option:

**/url:VSTFS:///LabManagement/objectType/**objectId

The objectId is the unique numeric identifier of the object.

The following table lists the valid keywords for the objectType keyword:

Object Type	Description
TeamProjectCollectionHostGroup	A host group of a team project collection
TeamProjectCollectionLibraryShare	A library share of a team project collection
TeamProject	A team project
TeamProjectHostGroup	A host group of a team project
TeamProjectLibraryShare	A library share of a team project
LabTemplate	A virtual machine or template in a team project library share
LabEnvironment	An environment that is deployed on a team project host group or stored in a team project library share.

Permissions

You can specify one or more of Lab Management permissions as the target of the /Allow, /Deny, or /Remove options. For a lists of available permissions, see the Lab Management Permissions section of the Permission reference for Team Foundation Server topic.

Use an asterisk (*) to specify all lab permissions.
Use commas to separate multiple permissions.

Remarks

If neither the /User or /Group option is specified, the current permissions of the specified object is displayed.