Add-ProvImageDefinitionConnection
Introduced in: Citrix Virtual Apps and Desktop 7 2411
Add an image definition connection.
Syntax
Add-ProvImageDefinitionConnection
-ImageDefinitionName <String>
-HypervisorConnectionName <String>
[-CustomProperties <String>]
[-RunAsynchronously]
[-PurgeJobOnSuccess]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Add-ProvImageDefinitionConnection
-ImageDefinitionUid <Guid>
-HypervisorConnectionUid <Guid>
[-CustomProperties <String>]
[-RunAsynchronously]
[-PurgeJobOnSuccess]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Provides the ability to link an image definition with a hypervisor connection and make customize configurations.
Examples
EXAMPLE 1
Add an image version spec.
Add-ProvImageDefinitionConnection -ImageDefinitionUid 7ccc900b-f737-416a-8f65-68383343007b -HypervisorConnectionUid 436cb4f7-2b57-484c-a364-d3c7795cb0c7 -RunAsynchronously
TaskId : a6566749-d445-4fcf-ab83-6bd2bba624b4
Active : False
Host : E73178-78-1
DateStarted : 5/9/2024 5:31:09 AM
Metadata : {}
ImageDefinitionName : test
ImageDefinitionUid : 7ccc900b-f737-416a-8f65-68383343007b
HypervisorConnectionName : azure28
HypervisorConnectionUid : 436cb4f7-2b57-484c-a364-d3c7795cb0c7
CustomProperties :
TaskState : Finished
TaskType : RemoveProvImageDefinitionConnection
LastUpdateTime : 5/9/2024 5:31:09 AM
CurrentOperation :
TerminatingError :
TaskProgress : 100
WorkFlowStatus : Completed
DateFinished : 5/9/2024 5:31:09 AM
TaskExpectedCompletion : 5/9/2024 5:31:09 AM
ActiveElapsedTime : 0
Status : Finished
TaskStateInformation : Completed
Type : RemoveProvImageDefinitionConnection
Parameters
-ImageDefinitionName
The name of image definition.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HypervisorConnectionName
The name of the hypervisor connection to be used.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ImageDefinitionUid
The identifier of image definition.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HypervisorConnectionUid
The identifier of the hypervisor connection to be used.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CustomProperties
The name of the hosting unit to be used for the image definition.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RunAsynchronously
Indicates whether or not the cmdlet should return before it is complete. If specified, the command returns an identifier for the task that was created. You can monitor this task using the Get-ProvTask cmdlet.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PurgeJobOnSuccess
Indicates that the task history will be removed from the database when the task has finished. This cannot be specified for tasks that are run asynchronously.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| 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 |
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
System.Management.Automation.PSCustomObject
This object provides details of the task that was run and contains the following information:
TaskId \<Guid\>
The identifier for the task that was performed.
Active \<Boolean\>
Indicates whether the task is still processing or is complete.
Host \<string\>
The name of the host on which the task is running or was run.
DateStarted \<DateTime\>
The date and time when the task was started.
ImageDefinitionUid \<Guid\>
The unique identifier of the image definition.
ImageDefinitionName \<string\>
The name of the image definition.
HypervisorConnectionName \<string\>
The name of the hypervisor connection being used by this image definition connection.
HypervisorConnectionUid \<Guid\>
The unique identifier of the hypervisor connection being used by this image definition connection.
CustomProperties \<string\>
The custom properties of the image definition connection.
TaskType \<Citrix.XDInterServiceTypes.JobType\>
The type of the task. For new image version tasks this is always "RemoveProvImageDefinitionConnection".
ActiveElapsedTime \<int\>
Number of seconds the task has taken for active execution.
TaskState \<Citrix.DesktopUpdateManager.SDK.NewProvisioningSchemeState\>
The state of the task.
Notes
In the case of failure, the following errors can result.
Error Codes
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.
ServiceStatusInvalidDb
An error occurred in the service while attempting a database operation - communication with the database failed for
for various reasons.
CommunicationError
An error occurred while communicating with the service.
PermissionDenied
The user does not have administrative rights to perform this operation.
ConfigurationLoggingError
The operation could not be performed because of a configuration logging error.
ExceptionThrown
An unexpected error occurred. To locate more details, see the Windows event logs on the controller being used or examine the XenDesktop logs.
UnsupportedByServer
The requested operation is not supported by this version of the service.
InvalidCustomProperties
The custom properties are not valid.
UnableToAddImageDefinitionConnectionDueToAlreadyExists
Unable to add image definition connection due to already exists.