Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Lock-ProvVM

August 3, 2023
Contributed by: 
C

Locks one or more VM(s).

Syntax


Lock-ProvVM [-VMID] <String[]> -ProvisioningSchemeName <String> [-Tag <String>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

Lock-ProvVM [-VMID] <String[]> -ProvisioningSchemeUid <Guid> [-Tag <String>] [-LoggingId <Guid>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Provides the ability to ‘lock’ virtual machine(s) with a tag string. This indicates that the VM is being used, and prevents other commands from removing the VM without unlocking it.

Parameters

Name Description Required? Pipeline Input Default Value
VMID Array of the virtual machine Ids (hypervisor context). true true (ByPropertyName)  
ProvisioningSchemeName The name of the provisioning scheme for which VMs must be locked. true true (ByPropertyName)  
ProvisioningSchemeUid The unique identifier of the provisioning scheme for which VMs must be locked. true false  
Tag The string to be held against the VM being locked. false 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. false false  
BearerToken Specifies the bearer token assigned to the calling user false false  
TraceParent Specifies the trace parent assigned for internal diagnostic tracing use false false  
TraceState Specifies the trace state assigned for internal diagnostic tracing user false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  
AdminAddress The address of a Citrix Virtual Apps and Desktops controller that the PowerShell snap-in connects to. You can provide this as a host name or an IP address. false false LocalHost. Once a value is provided by any cmdlet, this value becomes the default.

Input Type

Citrix.Machinecreation.Sdk.Provisionedvirtualmachine

You can pipe an object containing parameters called ‘VMId’ and ‘ProvisioningSchemeName’ to Lock-ProvVM.

Return Values

Notes

In the case of failure, the following errors can result.

  • VMDoesNotExist: The specified VM cannot be located.

  • VMAlreadyLocked: The VM is already unlocked.

  • VMDoesNotExistForProvisioningScheme: The specified VM does exist in the hypervisor, but is not part of the specified provisioning scheme.

  • PermissionDenied: The user is not authorized to perform this operation ConfigurationLoggingError The operation could not be performed because of a configuration logging error 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.

  • 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.

Examples

Example 1 


C:\PS>Lock-ProvVM -provisioningSchemeName MyScheme -VMId  bc79802c-ba6e-8de8-99e9-4c35d7ad24b4 -Tag LockedString

<!--NeedCopy-->

Description

Locks the VM with the Id ‘bc79802c-ba6e-8de8-99e9-4c35d7ad24b4’ in the provisioning scheme ‘MyScheme’ with the tag ‘LockedString’.

Example 2 


C:\PS>Get-ProvVM -provisioningSchemeName MyScheme | Lock-ProvVM -Tag LockedString

<!--NeedCopy-->

Description

Locks all the VMs in the provisioning scheme ‘MyScheme’ with the tag ‘LockedString’.

Lock-ProvVM
August 3, 2023
Contributed by: 
C
August 3, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.