Citrix Daas SDK

Lock-ProvVM

November 26, 2024

Contributed by:

C C

Locks one or more VM(s).

Syntax

Lock-ProvVM
    -ProvisioningSchemeName <String>
    [-VMID] <String[]>
    [-Tag <String>]
    [-LoggingId <Guid>]
    [<CitrixCommonParameters>]
    [<CommonParameters>]
<!--NeedCopy-->

Lock-ProvVM
    -ProvisioningSchemeUid <Guid>
    [-VMID] <String[]>
    [-Tag <String>]
    [-LoggingId <Guid>]
    [<CitrixCommonParameters>]
    [<CommonParameters>]
<!--NeedCopy-->

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.

Examples

EXAMPLE 1

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

Lock-ProvVM -provisioningSchemeName MyScheme -VMId  bc79802c-ba6e-8de8-99e9-4c35d7ad24b4 -Tag LockedString
<!--NeedCopy-->

EXAMPLE 2

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

Get-ProvVM -provisioningSchemeName MyScheme | Lock-ProvVM -Tag LockedString
<!--NeedCopy-->

Parameters

-ProvisioningSchemeName

The name of the provisioning scheme for which VMs must be locked.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	True

-ProvisioningSchemeUid

The unique identifier of the provisioning scheme for which VMs must be locked.

Type:	Guid
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	True

-VMID

Array of the virtual machine Ids (hypervisor context).

Type:	String[]
Position:	2
Default value:	None
Required:	True
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

-Tag

The string to be held against the VM being locked.

Type:	String
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.ProvisionedVirtualMachine

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

Outputs

None

By default, this cmdlet returns no output.

Notes

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.

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.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Lock-ProvVM

November 26, 2024

Contributed by:

C C

November 26, 2024

Contributed by:

C C

Lock-ProvVM

Syntax

Description

Examples

EXAMPLE 1

EXAMPLE 2

Parameters

-ProvisioningSchemeName

-ProvisioningSchemeUid

-VMID

-Tag

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

Citrix.MachineCreation.Sdk.ProvisionedVirtualMachine

Outputs

None

Notes

Related Links

In this article