Citrix Virtual Apps and Desktops SDK

Restart-ProvSchedule

Introduced in: Citrix Virtual Apps and Desktop 7 2407

Restarts a Provisioning Schedule

Syntax

Restart-ProvSchedule
       -ScheduleId <Guid>
       -NextScheduledStartTimeInUTC <DateTime>
       -RecurringSchedule <ProvisioningScheduleFrequency>
       [-LoggingId <Guid>]
       [<CitrixCommonParameters>]
       [<CommonParameters>]
<!--NeedCopy-->

Description

Reactivates a cancelled Provisioning Schedule with a new start time and frequency

Examples

Parameters

-ScheduleId

Indicates the Guid of the Provisioning Schedule

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

-NextScheduledStartTimeInUTC

Indicates the new start time in UTC at which the Provisioning Schedule 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

-RecurringSchedule

Indicates the new recurring frequency

Type: ProvisioningScheduleFrequency
Accepted values: Monthly, Biweekly, Weekly, Daily
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.

Restart-ProvSchedule