-
-
-
-
-
-
-
-
-
-
-
Publish-ProvMasterVMImage
-
-
-
-
-
This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
Publish-ProvMasterVMImage
Update the master image associated with the provisioning scheme.
Syntax
Publish-ProvMasterVMImage
-MasterImageVM <String>
[-DataDisk <String>]
[-ProvisioningSchemeName] <String>
[-DoNotStoreOldImage]
[-VhdTemplateSource <String>]
[-VhdResultDestination <String>]
[-AppScanResultsFile <String>]
[-FunctionalLevel <String>]
[-MasterImageNote <String>]
[-RunAsynchronously]
[-PurgeJobOnSuccess]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Publish-ProvMasterVMImage
-MasterImageVM <String>
[-DataDisk <String>]
-ProvisioningSchemeUid <Guid>
[-DoNotStoreOldImage]
[-VhdTemplateSource <String>]
[-VhdResultDestination <String>]
[-AppScanResultsFile <String>]
[-FunctionalLevel <String>]
[-MasterImageNote <String>]
[-RunAsynchronously]
[-PurgeJobOnSuccess]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Publish-ProvMasterVMImage
[-ProvisioningSchemeName] <String>
[-DoNotStoreOldImage]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Publish-ProvMasterVMImage
-ProvisioningSchemeUid <Guid>
[-DoNotStoreOldImage]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Description
Provides the ability to update the hard disk image used to create virtual machines. If the provisioning scheme is a ‘CleanOnBoot’ type, then the next time that virtual machines are started, their hard disks are updated to this new image. Regardless of the ‘CleanOnBoot’ type, all new virtual machines created after this command will use this new hard disk image.
A background task will be created to remove the old hard disk copies. You can locate and monitor this task using the Get-ProvTask cmdlet.
A snapshot or VM template is used rather than a VM, so that the content of the hard disk for the provisioning scheme can be easily determined.
As the snapshot or VM template are specified using a path into the Citrix Host Service PowerShell Provider, the Citrix Host Service PowerShell snap-in must also be loaded to use this cmdlet.
The previous hard disk image path is stored into the history (see Get-ProvSchemeMasterVMImageHistory). The data stored in the history allows to do a rollback to revert to the previous hard disk image if required.
Examples
EXAMPLE 1
Updates the master hard disk image for the provisioning Scheme “MyScheme” to use the “base.snapshot” hard disk image.
Publish-ProvMasterVMImage -ProvisioningSchemeName MyScheme -MasterImageVM XDHyp:\HostingUnits\HostUnit1\RhoneCC_baseXP.vm\base.snapshot
TaskId : 248f102f-073f-45fe-aea9-1819a6d6dd1f
Active : False
Host : MyHost
DateStarted : 17/05/2010 17:37:57
Type : PublishImage
Metadata : {}
WorkflowStatus : Completed
ProvisioningSchemeUid : 7585f0de-192e-4847-a6d8-22713c3a2f42
ProvisioningSchemeName : MyScheme
MasterImage : /RhoneCC_baseXP.vm/base.snapshot
HostingUnitName : HostUnit1
HostingUnitUid : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501
MasterImageNote :
ADIdentityPoolName :
ADIdentityPoolUid : 03743136-e43b-4a87-af74-ab71686b3c16
CurrentOperation :
TaskState : Finished
TaskStateInformation :
<!--NeedCopy-->
Parameters
-MasterImageVM
The path in the hosting unit provider to the VM snapshot or template that will be used. This identifies the hard disk to be used and the default values for the memory and processors. This must be a path to a Snapshot or Template item in the same hosting unit used by the provisioning scheme specified by ProvisioningSchemeName or ProvisioningSchemeUid. Valid paths are of the format:
XDHyp:\HostingUnits\<HostingUnitName>\<path>\<VMName>.vm\<SnapshotName>.snapshot XDHyp:\HostingUnits\<HostingUnitName>\<path>\<TemplateName>.template
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-ProvisioningSchemeUid
The unique identifier of the provisioning scheme to which the hard disk image should be updated.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProvisioningSchemeName
The name of the provisioning scheme to which the hard disk image should be updated.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-DataDisk
The path in the hosting unit provider to the data disk that will be used. This identifies the hard disk to be used. This must be a path to a disk item in the same hosting unit used by the provisioning scheme specified by ProvisioningSchemeName or ProvisioningSchemeUid. Valid paths are of the format:
XDHyp:\HostingUnits\<HostingUnitName>\<path>\<VMName>.vm\<MyDataDisk>.disk
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-VhdTemplateSource
A file path to a source VHD template to be used when performing application scanning during image preparation. The presence of this parameter in conjunction with VhdResultDestination implies that application scanning is to be performed
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VhdResultDestination
A file path (including file name) where the VHD disk file containing the results of application scanning should be written.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AppScanResultsFile
File name to which the results of application scanning should be written.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FunctionalLevel
The FunctionalLevel of the VDA installed on the given MasterImageVM.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MasterImageNote
The note of the master image.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RunAsynchronously
Indicates whether the cmdlet should return before it completes. 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 once the task completes. This cannot be specified for tasks that run asynchronously.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DoNotStoreOldImage
Indicates that the current image should not be added to the image history list for the provisioning scheme. This is useful when rolling back to a previous image.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| 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
Citrix.MachineCreation.Sdk.ProvisioningScheme
You can pipe an object containing a parameter called ‘ProvisioningSchemeName’ to Publish-ProvMasterVMImage.
Outputs
Guid
When “RunAsynchronously” is specified, this identifier is returned to provide the task identifier.
System.Management.Automation.PSCustomObject
This object provides details of the task run and contains the following information:
TaskId <Guid>
The identifier for the task that was performed.
Active <bool>
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.
Type <Citrix.XDInterServiceTypes.JobType>
The type of the task. For publish master image for provisioning scheme tasks this is always “PublishImage”.
Metadata <Citrix.MachineCreation.Sdk.Metadata[]>
The list of metadata stored against the task. For new tasks this will be empty until metadata is added.
WorkflowStatus <System.Workflow.Runtime.WorkflowStatus>
Indicates the status of the workflow that is being used to process the task.
ProvisioningSchemeName <string>
The name of the provisioning scheme associated with the task.
ProvisioningSchemeUid <Guid>
The unique identifier of the provisioning scheme associated with the task.
MasterImage <string>
The path of the VM snapshot or template that was used as the master image for the task.
IdentityPoolName <string>
The name of the identity pool being used for this task.
IdentityPoolUid <guid>
The unique identifier of the identity pool being used for this task.
HostingUnitName <string>
The name of the hosting unit being used for this task.
HostingUnitUid
The unique identifier of the hosting unit being used for this task.
MasterImageNote
The note of the master image.
TaskState <Citrix.DesktopUpdateManager.SDK.NewProvisioningSchemeState>
The state of the task. This can be any of the following:
Processing
Indicates that the task has just begun and has not done anything yet.
LocatingResources,
Indicates that the workflow is locating resources from other services.
HostingUnitNotFound
Indicates that the task failed because the required hosting unit could not be located.
VirtualMachineSnapshotNotFound
Indicates that the task failed because the required snapshot or VM template could not be located.
ConsolidatingMasterImage
Indicates that the task is consolidating the master image.
ReplicatingConsolidatedImageToAllStorage
Indicates that the task is replicating the consolidated master image.
StoringProvisioningScheme
Indicates that the task is storing the provisioning scheme data to the database.
Finished
Indicates that the task has completed with no errors.
ProvisioningSchemeAlreadyExists
Indicates that the task failed because a provisioning scheme with the same name already exists.
IdentityPoolNotFound
Indicates that the task failed because the identity pool specified could not be found.
MasterVMImageIsNotPartOfProvisioningSchemeHostingUnit,
Indicates that the hosting unit that the master image originated from is not the same hosting unit that the provisioning scheme is defined to use.
MasterVmImageIsNotASnapshot
Indicates that the task failed because the master VM image path does not refer to a snapshot or a VM template item.
ProvisioningSchemeNotFound
Could not find a provisioning scheme with the specified name.
TaskAlreadyRunningForProvisioningScheme
A task for a provisioning scheme with the same name is already running.
InvalidMasterVMConfiguration
The VM snapshot or VM template specified as the master had an invalid configuration.
InvalidMasterVMState
The VM snapshot or VM template specified as the master is currently in an invalid state.
InsufficientResources
Indicates that the task failed because the hypervisor did not have enough resources to complete the task.
StorageNotFound
Indicates that no associated storage was found in the hosting unit.
Canceled
Indicates that the task was stopped by user intervention (using Stop-ProvTask).
TaskStateInformation <string>
Holds string data providing more details about the current task state.
TaskProgress <double>
The progress of the task 0-100%.
Notes
The cmdlet is associated with a task of type PublishImage, and while active will move through the following operations (CurrentOperation field)
ValidatingInputs
ConsolidatingMasterImage
PreparingMasterImage
ReplicatingMasterImage
CommittingScheme
Only one long-running task per provisioning scheme can be processed at any one time.
In the case of failure, the following errors can result.
Error Codes
ProvisioningSchemeNotFound
The specified provisioning scheme could not be located.
ProvisioningSchemeNotReady
The specified provisioning scheme is not in Ready state.
JobCreationFailed
The requested task could not be started.
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.
WorkflowHostUnavailable
The task could not be started because the database connection is inactive.
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. For more details, see the Windows event logs on the controller being used or Citrix Virtual Apps and Desktops logs.
Related Links
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.