| external help file | Module Name | online version | schema |
|---|---|---|---|
Intersight.PowerShell.dll-Help.xml |
Intersight.PowerShell |
2.0.0 |
Fill in the Synopsis
Set-IntersightSchedulerTaskSchedule [-Action< SchedulerTaskSchedule.ActionEnum>][-AdditionalProperties< System.Collections.Generic.Dictionary`2[string,object]>][-Description< string>][[-Moid]< string>][-Name< string>][-Policy< SchedulerSchedulePolicyRelationship>][-ScheduleParams< SchedulerBaseScheduleParams>][-SuspendEndTime< DateTime>][-Tags< System.Collections.Generic.List`1[MoTag]>][-TaskRequest< SchedulerRestStimTaskRequest>][-Type< SchedulerTaskSchedule.TypeEnum>][-UsePolicy< bool>][-IfMatch< String>][-Json< SwitchParameter>][-WithHttpInfo< SwitchParameter>]
Update a 'SchedulerTaskSchedule' resource.
The action of the scheduled task such as suspend or resume.\n* None - No action is set (default).\n* Suspend - Suspend a scheduled task indefinitely.\n* Resume - Resume a suspended scheduled task.\n* SuspendTill - Suspend the scheduled task until a specified end-date. Not supported in this release.
Type: SchedulerTaskSchedule.ActionEnum
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseType: System.Collections.Generic.Dictionary`2[string,object]
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseA description to describe the schedule for easier identification.
Type: string
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseThe unique identifier of this Managed Object instance.
Type: string
Parameter Sets: (All)
Aliases:
Required: true
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseA schedule name for easier identification (not required to be unique).
Type: string
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseA reference to a schedulerSchedulePolicy resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.
Note:- To get the relationship object pass the MO to the cmdlet Get-IntersightMoMoRef or use the cmdlet Initialize-IntersightMoMoRef.
Type: SchedulerSchedulePolicyRelationship
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseAccording to the schedule type this property is evaluated. If the property Type is set to OneTime, then the ObjectType must be scheduler.OneTimeScheduleParams. If the Type is Recurring, then the ObjectType must be scheduler.RecurringScheduleParams.
Note :- Use Initialize-IntersightSchedulerBaseScheduleParams to create the object of complex type SchedulerBaseScheduleParams
Type: SchedulerBaseScheduleParams
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseSuspend a task until an end date. this applies only to the action suspendTill.
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseNote :- Use Initialize-IntersightMoTag to create the object of complex type MoTag
Type: System.Collections.Generic.List`1[MoTag]
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseAccording to the schedule type the recurring params are populated.
Note :- Use Initialize-IntersightSchedulerRestStimTaskRequest to create the object of complex type SchedulerRestStimTaskRequest
Type: SchedulerRestStimTaskRequest
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseAn Enum describing the type of scheduler to use.\n* None - No value was set for the schedule type (Enum value None).\n* OneTime - Define a one-time task execution time that will not automatically repeat.\n* Recurring - Specify a recurring task cadence based on a predefined pattern, such as daily, weekly, monthly, or every <interval> pattern.
Type: SchedulerTaskSchedule.TypeEnum
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseIndicates if the schedule is policy based or not.
Type: bool
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseFor methods that apply server-side changes, and in particular for PUT, If-Match can be used to prevent the lost update problem. It can check if the modification of a resource that the user wants to upload will not override another change that has been done since the original resource was fetched. If the request cannot be fulfilled, the 412 (Precondition Failed) response is returned. When modifying a resource using POST or PUT, the If-Match header must be set to the value of the resource ModTime property after which no lost update problem should occur. For example, a client send a GET request to obtain a resource, which includes the ModTime property. The ModTime indicates the last time the resource was created or modified. The client then sends a POST or PUT request with the If-Match header set to the ModTime property of the resource as obtained in the GET request.
Type: String
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True False
Accept wildcard characters: FalseReturns the json payload received in response.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True False
Accept wildcard characters: FalseReturns the HTTP response with headers and content.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
PS C:\> Set-IntersightSchedulerTaskSchedule{ Add example description here }
Get-IntersightSchedulerTaskSchedule
Initialize-IntersightMoVersionContext
Initialize-IntersightSchedulerBaseScheduleParams
Initialize-IntersightSchedulerRestStimTaskRequest
Initialize-IntersightSchedulerTaskSchedulePolicyExecutionStatus
Initialize-IntersightSchedulerTaskScheduleStatus