Add-HypHypervisorConnectionScope
Add the specified HypervisorConnection(s) to the given scope(s).
Syntax
Add-HypHypervisorConnectionScope
[-Scope] <String[]>
-HypervisorConnectionUid <Guid[]>
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Add-HypHypervisorConnectionScope
[-Scope] <String[]>
-InputObject <HypervisorConnection[]>
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Add-HypHypervisorConnectionScope
[-Scope] <String[]>
-HypervisorConnectionName <String[]>
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
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.
Examples
EXAMPLE 1
Adds a single HypervisorConnection to the 'Finance' scope.
Add-HypHypervisorConnectionScope Finance -HypervisorConnectionUid 6702C5D0-C073-4080-A0EE-EC74CB537C52
EXAMPLE 2
Adds a single HypervisorConnection to the multiple scopes.
Add-HypHypervisorConnectionScope Finance,Marketing -HypervisorConnectionUid 6702C5D0-C073-4080-A0EE-EC74CB537C52
EXAMPLE 3
Adds all visible HypervisorConnection objects to the 'Finance' scope.
Get-HypHypervisorConnection | Add-HypHypervisorConnectionScope Finance
EXAMPLE 4
Adds HypervisorConnection objects with a name starting with an 'A' to the 'Finance' scope.
Add-HypHypervisorConnectionScope Finance -HypervisorConnectionName A*
Parameters
-InputObject
Specifies the HypervisorConnection objects to be added.
| Type: | HypervisorConnection[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName, ByValue) |
| Accept wildcard characters: | False |
-HypervisorConnectionUid
Specifies the HypervisorConnection objects to be added by HypervisorConnectionUid.
| Type: | Guid[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName, ByValue) |
| Accept wildcard characters: | False |
-HypervisorConnectionName
Specifies the HypervisorConnection objects to be added by HypervisorConnectionName.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName, ByValue) |
| Accept wildcard characters: | True |
-Scope
Specifies the scopes to add the objects to.
| Type: | String[] |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| 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 |
-SkipCertificateValidation
Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2511 |
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
None
You can't pipe objects to this cmdlet.
Outputs
None
By default, this cmdlet returns no output.
Notes
If the command fails, the following errors can be returned.
Error Codes
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.