Citrix Virtual Apps and Desktops SDK

New-ProvMaintenanceCycle

Introduced in: Citrix Virtual Apps and Desktop 7 2407

Creates a new Maintenance Cycle

Syntax

New-ProvMaintenanceCycle
   [-MaintenanceCycleDescription <String>]
   -ScheduledStartTimeInUTC <DateTime>
   -MaxDurationInMinutes <Int32>
   -Operations <MaintenanceCycleOperationType[]>
   -CatalogName <String>
   [-PurgeDBAfterInDays <Int32>]
   [-SessionWarningTimeInMinutes <Int32>]
   [-SessionLogOffMessage <String>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Lets you schedule a maintenance cycle for a catalog for an operation/s type. The catalog is meant to start at the time user specifies in ScheduledStartTimeInUTC. User also provides MaxDurationInMinutes which is meant for the maximum amount of time the maintenance cycle can run

Examples

Parameters

-ScheduledStartTimeInUTC

Indicates the time in UTC at which the maintenance cycle will be started 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 total allocated duration in minutes to the maintenance cycle

Type: Int32
Position: Named
Default value: 30
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-Operations

Indicates the operations to be performed on the maintenance cycle

Type: MaintenanceCycleOperationType[]
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-CatalogName

Indicates the catalog bank to be used for the maintenance cycle

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

-MaintenanceCycleDescription

A brief overview to understand what the maintenance cycle is about

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

-PurgeDBAfterInDays

The duration of time in days for mcs to have the data in database after maintenance cycles goes into completed states,

once the time expires the data will be purged

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

-SessionWarningTimeInMinutes

Buffer Time provided to the user to save date before powering down the vm by mcs

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

-SessionLogOffMessage

Message intended to be displayed to the user before powering down the vm

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

None

You can’t pipe objects to this cmdlet.

Outputs

None

By default, this cmdlet returns no output.

New-ProvMaintenanceCycle