Citrix Virtual Apps and Desktops SDK

Remove-BrokerHypervisorConnection

Removes a hypervisor connection from the system.

Syntax

Remove-BrokerHypervisorConnection
      [-InputObject] <HypervisorConnection[]>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->
Remove-BrokerHypervisorConnection
      [-Name] <String>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

Remove-BrokerHypervisorConnection removes a hypervisor connection from the system. A hypervisor connection cannot be removed if it’s being used by a machine.

Examples

EXAMPLE 1

This command removes a hypervisor connection by name.

Remove-BrokerHypervisorConnection -Name "Xen Server Connection"
<!--NeedCopy-->

EXAMPLE 2

Gets a hypervisor connection by preferred controller and removes it.

$hvConn = Get-BrokerHypervisorConnection -PreferredController "controllerName" -Name "Xen Server Connection"
Remove-BrokerHypervisorConnection -InputObject $hvConn
<!--NeedCopy-->

Parameters

-InputObject

Specifies the hypervisor connection object to remove.

Type: HypervisorConnection[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

Specifies the name of the hypervisor connection object to remove.

Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-LoggingId

Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop Director typically create High Level Operations. PowerShell scripts can also wrap a series of cmdlet calls in a High Level Operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

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

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

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

Citrix.Broker.Admin.SDK.HypervisorConnection

You can pipe the hypervisor connection to be removed to Remove-BrokerHypervisorConnection.

Outputs

None

By default, this cmdlet returns no output.

Remove-BrokerHypervisorConnection