| external help file | Module Name | online version | schema |
|---|---|---|---|
Intersight.PowerShell.dll-Help.xml |
Intersight.PowerShell |
2.0.0 |
Fill in the Synopsis
Set-IntersightWorkflowPowerShellBatchApiExecutor [-AdditionalProperties< System.Collections.Generic.Dictionary`2[string,object]>][-Batch< System.Collections.Generic.List`1[Intersight.Model.WorkflowApi]>][-CancelAction< System.Collections.Generic.List`1[Intersight.Model.WorkflowApi]>][-Constraints< WorkflowTaskConstraints>][-Description< string>][-ErrorResponseHandler< WorkflowErrorResponseHandlerRelationship>][[-Moid]< string>][-Name< string>][-Outcomes< object>][-Output< object>][-RetryFromFailedApi< bool>][-SkipOnCondition< string>][-Tags< System.Collections.Generic.List`1[MoTag]>][-TaskDefinition< WorkflowTaskDefinitionRelationship>][-UiRenderingData< object>][-IfMatch< String>][-Json< SwitchParameter>][-WithHttpInfo< SwitchParameter>]
Update a 'WorkflowPowerShellBatchApiExecutor' resource.
Type: 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: FalseNote :- Use Initialize-IntersightIntersight.Model.WorkflowApi to create the object of complex type Intersight.Model.WorkflowApi
Type: System.Collections.Generic.List`1[Intersight.Model.WorkflowApi]
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseNote :- Use Initialize-IntersightIntersight.Model.WorkflowApi to create the object of complex type Intersight.Model.WorkflowApi
Type: System.Collections.Generic.List`1[Intersight.Model.WorkflowApi]
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseConstraints for matching this task against the task definition.
Note :- Use Initialize-IntersightWorkflowTaskConstraints to create the object of complex type WorkflowTaskConstraints
Type: WorkflowTaskConstraints
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseDetailed description of the batch APIs.
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 workflowErrorResponseHandler 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: WorkflowErrorResponseHandlerRelationship
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: FalseName of the batch API task.
Type: string
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseCollection of possible task outcomes, represented as workflow.Outcome objects. Outcomes can be mapped to messages and are evaluated in the given order. \nA catch-all success or failure outcome with condition 'true' can be included at the end. Optional property; if not specified, the task defaults to success.
Type: object
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseJSON mapping of extracted API response values to task output parameters, using API response grammar defined in Intersight Orchestrator.
Type: object
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseFlag indicating if the retry task should from the failed API or the first API in the batch execution; default value is false.
Type: bool
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseOptional skip expression allowing the batch API executor to skip task execution when the provided Go template expression evaluates to true. \nIf not specified, the API will always be executed.
Type: string
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: FalseA reference to a workflowTaskDefinition 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: WorkflowTaskDefinitionRelationship
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseData required for rendering the task in the user interface.
Type: object
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-IntersightWorkflowPowerShellBatchApiExecutor{ Add example description here }
Get-IntersightWorkflowPowerShellBatchApiExecutor
Initialize-IntersightIntersight.Model.WorkflowApi
Initialize-IntersightMoVersionContext
Initialize-IntersightWorkflowTaskConstraints