Request-ProvVMUpdate
(DEPRECATED) Requests a property update on provisioned virtual machines.
Syntax
Request-ProvVMUpdate
-ProvisioningSchemeName <String>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Request-ProvVMUpdate
-ProvisioningSchemeName <String>
-VMName <String[]>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Request-ProvVMUpdate
-ProvisioningSchemeUid <Guid>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Request-ProvVMUpdate
-ProvisioningSchemeUid <Guid>
-VMName <String[]>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
This cmdlet has been deprecated and replaced by Set-ProvVMUpdateTimeWindow. Please see the examples on this page that describe how to transition to the new cmdlet.
Provides the ability to synchronize the properties of existing virtual machines with any changes occurred on the provisioning scheme.
This cmdlet updates the ProvisioningSchemeUpdateRequested field on virtual machines to the current time, which indicates that the machines will synchronize to the property updates occurred on the provisioning scheme upon next start.
Examples
EXAMPLE 1
To request all machines in a catalog to apply property updates on next boot, use Set-ProvVMUpdateTimeWindow with parameters -StartsNow and -DurationInMinutes -1.
Request-ProvVMUpdate -ProvisioningSchemeName AzuPS
is equivalent to
Set-ProvVMUpdateTimeWindow -ProvisioningSchemeName AzuPS -StartsNow -DurationInMinutes -1
Parameters
-ProvisioningSchemeName
The name of the provisioning scheme.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName, ByValue) |
| Accept wildcard characters: | False |
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName, ByValue) |
| Accept wildcard characters: | False |
-VMName
List of VM names requesting for update. If not specified, all VMs in the machine catalog associated with the specified provisioning scheme will request for a property update.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName, ByValue) |
| Accept wildcard characters: | False |
-ProvisioningSchemeUid
The unique identifier of the provisioning scheme.
| Type: | Guid |
| Position: | Named |
| 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 |
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.ProvisionedVirtualMachine
You can pipe an object containing parameters called 'VMId' and 'ProvisioningSchemeName' to Request-ProvVMUpdate.
Outputs
None
By default, this cmdlet returns no output.
Notes
Running Set-ProvScheme to update provisioning scheme properties will only affect future provisioned machines. To request existing VMs in a catalog to be brought up to date upon the next power on, use this cmdlet to request certain or all VMs created from the provisioning scheme associated with the catalog to be updated.
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.