Edit

Share via

Set-InsightsCapabilitySchedule

Module:
SystemInsights Module

Sets a prediction schedule for the specified capabilities.

Syntax

Daily with interval 

Set-InsightsCapabilitySchedule
    [-Name] <String>
    [[-DaysInterval] <UInt16>]
    [[-At] <DateTime>]
    [[-ComputerName] <String>]
    [-Daily]
    [-Credential <PSCredential>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Daily with days of week 

Set-InsightsCapabilitySchedule
    [-Name] <String>
    [[-DaysOfWeek] <DayOfWeek[]>]
    [[-At] <DateTime>]
    [[-ComputerName] <String>]
    [-Daily]
    [-Credential <PSCredential>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Minute 

Set-InsightsCapabilitySchedule
    [-Name] <String>
    [[-DaysOfWeek] <DayOfWeek[]>]
    [[-MinutesInterval] <UInt16>]
    [[-ComputerName] <String>]
    [-Minute]
    [-Credential <PSCredential>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Hourly 

Set-InsightsCapabilitySchedule
    [-Name] <String>
    [[-DaysOfWeek] <DayOfWeek[]>]
    [[-HoursInterval] <UInt16>]
    [[-ComputerName] <String>]
    [-Hourly]
    [-Credential <PSCredential>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Default 

Set-InsightsCapabilitySchedule
    [-Name] <String>
    [[-ComputerName] <String>]
    [-DefaultSchedule]
    [-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.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False
Aliases:A

Parameter sets

Daily with Interval
Position:4
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Daily with Days
Position:4
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ComputerName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:CN

Parameter sets

(All)
Position:0
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Credential

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

Parameter properties

Type:PSCredential
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Daily

Uses days as the scheduled time interval.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:D

Parameter sets

Daily with Interval
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Daily with Days
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False
Aliases:DI

Parameter sets

Daily with Interval
Position:3
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DaysOfWeek

Specifies the days of the week to run the capability.

Parameter properties

Type:

DayOfWeek[]

Default value:None
Accepted values:Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday
Supports wildcards:False
DontShow:False
Aliases:DOW

Parameter sets

Daily with Days
Position:3
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Minute
Position:3
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Hourly
Position:3
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DefaultSchedule

Restores the default schedule of the capability.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:DS

Parameter sets

Default
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Hourly

Uses hours as the scheduled time interval.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:H

Parameter sets

Hourly
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False
Aliases:HI

Parameter sets

Hourly
Position:3
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Minute

Uses minutes as the scheduled time interval.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:M

Parameter sets

Minute
Position:2
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:UInt16
Default value:None
Supports wildcards:False
DontShow:False
Aliases:MI

Parameter sets

Minute
Position:3
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies a capability using a capability name.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:N

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:True
Value from remaining arguments:False

-WhatIf

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.SystemInsights.Management.PowerShell.Capability

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

Outputs

None