Skip to main content

Disable-VSTeamAgent

SYNOPSIS​

Disables an agent in a pool.

SYNTAX​

Disable-VSTeamAgent -PoolId <Int32> -Id <Int32[]> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION​

Disables an agent in a pool.

EXAMPLES​

Example 1​

Disable-VSTeamAgent -PoolId 4 -Id 23

This command disables the agent with the ID 23 in the pool with the ID 4.

Example 2​

Disable-VSTeamAgent -PoolId 2 -Id 10, 11, 12

This example disables multiple agents with the IDs 10, 11, and 12 in the pool with the ID 2.

Example 3​

$agentIDs = @(33,34,35)
Disable-VSTeamAgent -PoolId 5 -Id $agentIDs

In this example, agents with IDs 33, 34, and 35 in the pool with the ID 5 are disabled using an array variable.

Example 4​

Get-VSTeamAgent -PoolId 3 | Where-Object { $_.status -eq "Online" } | ForEach-Object { Disable-VSTeamAgent -PoolId 3 -Id $_.id }

This command retrieves all agents in the pool with the ID 3, filters to get only the online agents, and then disables each of those online agents.

Example 5​

Disable-VSTeamAgent -PoolId 6 -Id 40 -Force

This example disables the agent with ID 40 in the pool with ID 6 without prompting for confirmation by using the `-Force` switch.

Example 6​

Disable-VSTeamAgent -PoolId 7 -Id 45 -WhatIf

This command shows what would happen if the agent with ID 45 in the pool with ID 7 was disabled, without actually disabling the agent.

PARAMETERS​

-PoolId​

Id of the pool.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Id​

Id of the agent to disable.

Type: Int32[]
Parameter Sets: (All)
Aliases: AgentID

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Force​

Forces the function without confirmation.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf​

Shows what would happen if the function runs. The function is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Confirm​

Prompts you for confirmation before running the function.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

System.String​

OUTPUTS​

NOTES​

Prerequisites:

Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.

tips:

  • check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo
  • use Set-VSTeamDefaultProject to set default project for every call
  • use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.
  • use Profiles to load an account and the correct version