Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Add-HypHypervisorConnectionScope

March 11, 2024
Contributed by: 
C

Add the specified HypervisorConnection(s) to the given scope(s).

Syntax


Add-HypHypervisorConnectionScope [-Scope] <String[]> -InputObject <HypervisorConnection[]> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Add-HypHypervisorConnectionScope [-Scope] <String[]> -HypervisorConnectionUid <Guid[]> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Add-HypHypervisorConnectionScope [-Scope] <String[]> -HypervisorConnectionName <String[]> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

The Add-HypHypervisorConnectionScope command is used to associate one or more HypervisorConnection objects with given scope(s).

There are multiple parameter sets for this cmdlet, allowing you to identify the HypervisorConnection objects in different ways: - HypervisorConnection objects can be piped in or specified by the InputObject parameter - The HypervisorConnectionUid parameter specifies objects by HypervisorConnectionUid - The HypervisorConnectionName parameter specifies objects by HypervisorConnectionName (supports wildcards)

To add a HypervisorConnection to a scope you need permission to change the scopes of the HypervisorConnection and permission to add objects to all of the scopes you have specified.

If the HypervisorConnection is already in a scope, that scope will be silently ignored.

Parameters

Name Description Required? Pipeline Input Default Value
Scope Specifies the scopes to add the objects to. true false  
InputObject Specifies the HypervisorConnection objects to be added. true true (ByValue, ByPropertyName)  
HypervisorConnectionUid Specifies the HypervisorConnection objects to be added by HypervisorConnectionUid. true true (ByValue, ByPropertyName)  
HypervisorConnectionName Specifies the HypervisorConnection objects to be added by HypervisorConnectionName. true true (ByValue, ByPropertyName)  
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. false false  
BearerToken Specifies the bearer token assigned to the calling user false false  
AdminClientIP Specifies the client IP of the calling user false false  
TraceParent Specifies the trace parent assigned for internal diagnostic tracing use false false  
TraceState Specifies the trace state assigned for internal diagnostic tracing use false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  
AdminAddress Specifies the address of a XenDesktop controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address. false false Localhost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

Return Values

None

Notes

If the command fails, the following errors can be returned.

  • UnknownObject: One of the specified objects was not found.

  • ScopeNotFound: One of the specified scopes was not found.

  • 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.

  • PermissionDenied: You do not have permission to execute this command with the specified objects or scopes.

  • AuthorizationError: There was a problem communicating with the Citrix Delegated Administration Service.

  • ConfigurationLoggingError: The operation could not be performed because of a configuration logging error.

  • CommunicationError: There was a problem communicating with the remote service.

  • ExceptionThrown: An unexpected error occurred. For more details, see the Windows event logs on the controller or the XenDesktop logs.

Examples

Example 1 


c:\PS>Add-HypHypervisorConnectionScope Finance -HypervisorConnectionUid 6702C5D0-C073-4080-A0EE-EC74CB537C52

<!--NeedCopy-->

Description

Adds a single HypervisorConnection to the ‘Finance’ scope.

Example 2 


c:\PS>Add-HypHypervisorConnectionScope Finance,Marketing -HypervisorConnectionUid 6702C5D0-C073-4080-A0EE-EC74CB537C52

<!--NeedCopy-->

Description

Adds a single HypervisorConnection to the multiple scopes.

Example 3 


c:\PS>Get-HypHypervisorConnection | Add-HypHypervisorConnectionScope Finance

<!--NeedCopy-->

Description

Adds all visible HypervisorConnection objects to the ‘Finance’ scope.

Example 4 


c:\PS>Add-HypHypervisorConnectionScope Finance -HypervisorConnectionName A\*

<!--NeedCopy-->

Description

Adds HypervisorConnection objects with a name starting with an ‘A’ to the ‘Finance’ scope.

Add-HypHypervisorConnectionScope
March 11, 2024
Contributed by: 
C
March 11, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.