Add-ProvImageDefinitionScope
Introduced in: Citrix Virtual Apps and Desktop 7 2511
Add the specified image definition(s) to the given scope(s).
Syntax
Add-ProvImageDefinitionScope
[-Scope] <String[]>
-ImageDefinitionUid <Guid[]>
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Add-ProvImageDefinitionScope
[-Scope] <String[]>
-InputObject <ImageDefinition[]>
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Add-ProvImageDefinitionScope
[-Scope] <String[]>
-ImageDefinitionName <String[]>
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
The Add-ProvImageDefinitionScope command is used to associate one or more image definitions with given scope(s).
To add an image definition to a scope, you need permission to change the scopes of the image definition and permission to add objects to all of the scopes you have specified.
If the image definition is already in a scope, that scope will be silently ignored.
Examples
EXAMPLE 1
Adds a single image definition to the 'Finance' scope.
Add-ProvImageDefinitionScope Finance -ImageDefinitionUid 6702C5D0-C073-4080-A0EE-EC74CB537C52
EXAMPLE 2
Adds a single image definition to the multiple scopes.
Add-ProvImageDefinitionScope Finance,Marketing -ImageDefinitionUid 6702C5D0-C073-4080-A0EE-EC74CB537C52
EXAMPLE 3
Adds all visible image definitions to the 'Finance' scope.
Get-ProvImageDefinition | Add-ProvImageDefinitionScope Finance
EXAMPLE 4
Adds all image definitions whose name starts with letter 'A' to the 'Finance' scope.
Add-ProvImageDefinitionScope Finance -ImageDefinitionName A*
Parameters
-InputObject
Specifies the ImageDefinition objects to be added.
| Type: | ImageDefinition[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName, ByValue) |
| Accept wildcard characters: | False |
-ImageDefinitionUid
Specifies the ImageDefinition objects to be added by the UID of the image definition.
| Type: | Guid[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName, ByValue) |
| Accept wildcard characters: | False |
-ImageDefinitionName
Specifies the ImageDefinition objects to be added by the name of the image definition.
| 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 |
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.MachineCreation.Sdk.ImageDefinition
You can pipe a ImageDefinition object or any object containing a parameter called 'ImageDefinitionName' or 'ImageDefinitionUid' to Add-ProvImageDefinitionScope.
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 Citrix Virtual Apps and Desktops logs.