Citrix Virtual Apps and Desktops SDK

Restart-ProvMaintenanceCycle

August 9, 2024

Contributed by:

Introduced in: Citrix Virtual Apps and Desktop 7 2407

Restarts a Maintenance Cycle

Syntax

Restart-ProvMaintenanceCycle
       -MaintenanceCycleId <Guid>
       -ScheduledStartTimeInUTC <DateTime>
       -MaxDurationInMinutes <Int32>
       [-LoggingId <Guid>]
       [<CitrixCommonParameters>]
       [<CommonParameters>]
<!--NeedCopy-->

Description

If a maintenance cycle has failed or is incomplete due to outdoor causes such as the hypervisor was down or insufficient time, this cmdlet helps to restart the cycle and process any failed/not-processed jobs

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

-ScheduledStartTimeInUTC

Indicates the new start time in UTC at which the maintenance cycle will be restarted This must be a date time powershell object and user is expected to supply it as a parameter to the cmdlet

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

-MaxDurationInMinutes

Indicates the new total allocated duration in minutes to the restarted maintenance cycle

Type:	Int32
Position:	Named
Default value:	30
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.

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

Restart-ProvMaintenanceCycle

August 9, 2024

Contributed by:

August 9, 2024

Contributed by:

Restart-ProvMaintenanceCycle

Syntax

Description

Examples

Parameters

-MaintenanceCycleId

-ScheduledStartTimeInUTC

-MaxDurationInMinutes

-LoggingId

CitrixCommonParameters

CommonParameters

Inputs

None

Outputs

None

Related Links

In this article