Update-ProvPvsScheme
Introduced in: Citrix Virtual Apps and Desktop 7 2511
Updates the PVS scheme.
Syntax
Update-ProvPvsScheme
-ProvisioningSchemeUid <Guid>
[-UpdateBdmFile]
[-VDisk <Guid>]
[-RunAsynchronously]
[-PurgeJobOnSuccess]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Update-ProvPvsScheme
-ProvisioningSchemeName <String>
[-UpdateBdmFile]
[-VDisk <Guid>]
[-RunAsynchronously]
[-PurgeJobOnSuccess]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Provides the ability to update an existing PVS scheme in Citrix Machine Creation Services.
Examples
EXAMPLE 1
Updates the PVS scheme named 'MyScheme' asynchronously.
Update-ProvPvsScheme -ProvisioningSchemeName "MyScheme" -RunAsynchronously
EXAMPLE 2
Updates the PVS scheme with the specified UID and purges the job on success.
Update-ProvPvsScheme -ProvisioningSchemeUid 5135a865-ba49-4e5f-87f2-2d65ee7a4e51 -PurgeJobOnSuccess
Parameters
-ProvisioningSchemeName
The name of the provisioning scheme to update.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProvisioningSchemeUid
The unique identifier of the provisioning scheme to update.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UpdateBdmFile
Update the BDM file for a Provisioning Scheme.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VDisk
PVS VDisk Id to which the target devices needs to be updated to
| Type: | Guid |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RunAsynchronously
Indicates whether the task is run asynchronously.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PurgeJobOnSuccess
Indicates whether the task history is removed from the database when the task finishes.
| 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 |
-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
None
You can't pipe objects to this cmdlet.
Outputs
The unique identifier of the job that was created to update the PVS scheme.
System.Management.Automation.PSCustomObject
Details of the updated PVS scheme.
Notes
In the case of failure, the following errors can result.
Error Codes
PartialData Only a subset of the available data was returned.
CouldNotQueryDatabase The query required to get the database was not defined.
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
CommunicationError An error occurred while communicating with the service.
DatabaseNotConfigured The operation could not be completed because the database for the service is not configured.
InvalidFilter A filtering expression was supplied that could not be interpreted for this cmdlet.
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.