Citrix Daas SDK

Remove-HypHypervisorConnectionAddress

August 9, 2024

Contributed by:

C C

Removes addresses from the list of available connection addresses.

Syntax

Remove-HypHypervisorConnectionAddress
      [-LiteralPath] <String>
      [-HypervisorAddress] <String>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

Use this command to remove addresses that can be used to connect to the hypervisor specified by the hypervisor connection. If all addresses are removed, the connection cannot be used until a valid address is added to the hypervisor connection.

Examples

EXAMPLE 1

The command removes the address “http:\\myserver.com” from the hypervisor connection called “MyHypervisorConnection”.

Remove-HypHypervisorConnectionAddress -LiteralPath XDHyp:\HostingUnits\MyHypervisorConnection -HypervisorAddress 'http:\\myserver.com'
<!--NeedCopy-->

EXAMPLE 2

The command removes all addresses from all the hypervisor connections currently defined.

Get-Item -Path XDHYP:\Connections\* | Remove-HypHypervisorConnectionAddress
<!--NeedCopy-->

Parameters

-LiteralPath

Specifies the path within a Host Service provider to the hosting unit item to which to add the address. The path specified must be in one of the following formats:

<drive>:\HostingUnits\<HostingUnitName>

or <drive>:\HostingUnits{HostingUnit Uid>}

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-HypervisorAddress

Specifies the address to be removed. If this parameter is not provided, all addresses are removed from the hypervisor connection.

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

-LoggingId

Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and 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

String

You can pipe a string that contains a path to Remove-HypHypervisorConnectionAddress (Path parameter).

Outputs

None

By default, this cmdlet returns no output.

Notes

Changes to a hypervisor connection affect all entities that reference the connection. If all addresses are removed from the connection, any other entities that reference the hypervisor connection (e.g. hosting units) cannot make new connections to the hypervisor.

In the case of failure, the following errors can result.

Error Codes

InputConnectionsPathInvalid

The path provided is not to an item in a subdirectory of a hosting unit item.

HypervisorConnectionAddressForeignKeyObjectDoesNotExist

The hypervisor connection to which the address is to be added could not be located.

HypervisorInMaintenanceMode

The hypervisor for the connection is in maintenance mode.

DatabaseError

An error occurred in the service while attempting a database operation.

DatabaseNotConfigured

The operation could not be completed because the database for the service is not configured.

DataStoreException

An error occurred in the service while attempting a database operation - communication with the database failed for

various reasons.

CommunicationError

An error occurred while communicating with the service.

PermissionDenied

The user does not have administrative rights to perform this operation.

ExceptionThrown

An unexpected error occurred. To locate more details, see the Windows event logs on the controller being used or examine the XenDesktop logs.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Remove-HypHypervisorConnectionAddress

August 9, 2024

Contributed by:

C C

August 9, 2024

Contributed by:

C C

Remove-HypHypervisorConnectionAddress

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

Parameters

-LiteralPath

-HypervisorAddress

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

String

Outputs

None

Notes

Related Links

In this article