Citrix Virtual Apps and Desktops SDK

Cancel-ProvMaintenanceCycle

Introduced in: Citrix Virtual Apps and Desktop 7 2407

Cancels a Maintenance Cycle

Syntax

Cancel-ProvMaintenanceCycle
      -MaintenanceCycleId <Guid>
      [-LoggingId <Guid>]
      [<CitrixCommonParameters>]
      [<CommonParameters>]
<!--NeedCopy-->

Description

Cancels an ongoing Maintenance Cycle, if the operation is not yet started by MCS on a virtual machine, the operation is cancelled.

However MCS does not cancel the operation that is running on the virtual machine, it is designed to allow it to continue and complete it

This is done to avoid putting the virtual machine in a bad state in the midst of an operation

Examples

Parameters

-MaintenanceCycleId

Indicates the Guid of the maintenance cycle

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

None

You can’t pipe objects to this cmdlet.

Outputs

None

By default, this cmdlet returns no output.

Cancel-ProvMaintenanceCycle