Modifier

Set-InsightsCapabilitySchedule

  • Reference
Module:
SystemInsights

Sets a prediction schedule for the specified capabilities.

Syntax

Set-InsightsCapabilitySchedule
   [-Name] <String>
   [-Daily]
   [[-DaysInterval] <UInt16>]
   [[-At] <DateTime>]
   [[-ComputerName] <String>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-InsightsCapabilitySchedule
   [-Name] <String>
   [-Daily]
   [[-DaysOfWeek] <DayOfWeek[]>]
   [[-At] <DateTime>]
   [[-ComputerName] <String>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-InsightsCapabilitySchedule
   [-Name] <String>
   [[-DaysOfWeek] <DayOfWeek[]>]
   [-Minute]
   [[-MinutesInterval] <UInt16>]
   [[-ComputerName] <String>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-InsightsCapabilitySchedule
   [-Name] <String>
   [[-DaysOfWeek] <DayOfWeek[]>]
   [-Hourly]
   [[-HoursInterval] <UInt16>]
   [[-ComputerName] <String>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-InsightsCapabilitySchedule
   [-Name] <String>
   [-DefaultSchedule]
   [[-ComputerName] <String>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-InsightsCapabilitySchedule cmdlet sets a prediction schedule for the specified capabilities.

Important

Some information relates to prereleased product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Examples

Example 1

PS C:\> Set-InsightsCapabilitySchedule -Name "CPU capacity forecasting" -Daily -DaysOfWeek Monday, Tuesday, Wednesday, Thursday, Friday -At 03:00

This example sets a daily schedule for the CPU capacity forecasting capability, which runs every weekday at 3am.

Example 2

PS C:\> Set-InsightsCapabilitySchedule -Name "CPU capacity forecasting" -Daily -DaysInterval 2

This example sets a daily schedule for the CPU capacity forecasting capability, which runs every 2 days.

Example 3

PS C:\> Set-InsightsCapabilitySchedule -Name "CPU capacity forecasting" -Hourly -HoursInterval 4 -DaysOfWeek Tuesday, Friday

This example sets a hourly schedule for the CPU capacity forecasting capability, which runs every 4 hours on Tuesday and Friday.

Example 4

PS C:\> Set-InsightsCapabilitySchedule -Name "CPU Capacity Forecasting" -DefaultSchedule

This example restores the default schedule for the CPU capacity forecasting capability.

Parameters

-At

Specifies the time of day to get a prediction. This parameter can only be specified for daily predictions.

Type:DateTime
Aliases:A
Position:4
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ComputerName

Specifies a fully qualified domain name (FQDN). If not specified, uses the local computer.

Type:String
Aliases:CN
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

Specifies the credential for accessing the computer specified by the -ComputerName parameter.

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

-Daily

Uses days as the scheduled time interval.

Type:SwitchParameter
Aliases:D
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-DaysInterval

Specifies the interval between days in the schedule. An interval of 1 produces a daily schedule. An interval of 2 runs the capability every other day.

Type:UInt16
Aliases:DI
Position:3
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DaysOfWeek

Specifies the days of the week to run the capability.

Type:DayOfWeek[]
Aliases:DOW
Accepted values:Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday
Position:3
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultSchedule

Restores the default schedule of the capability.

Type:SwitchParameter
Aliases:DS
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Hourly

Uses hours as the scheduled time interval.

Type:SwitchParameter
Aliases:H
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-HoursInterval

Specifies the interval between hours in the schedule. An interval of 1 produces an hourly schedule. An interval of 2 produces a prediction every 2 hours.

Type:UInt16
Aliases:HI
Position:3
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Minute

Uses minutes as the scheduled time interval.

Type:SwitchParameter
Aliases:M
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-MinutesInterval

Specifies the interval between minutes in the schedule. An interval of 5 produces a prediction every 5 minutes. An interval of 10 produces a prediction every 10 minutes. The default value is 30, and it is not recommended to specify low values of this parameter, as it may negatively impact performance.

Type:UInt16
Aliases:MI
Position:3
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies a capability using a capability name.

Type:String
Aliases:N
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.SystemInsights.Management.PowerShell.Capability

You can use the pipeline operator to pass a capability object to the Name parameter.

Outputs

None