-
Notifications
You must be signed in to change notification settings - Fork 52
Wait HPOVTaskComplete
Wait for a task to complete.
Wait-HPOVTaskComplete [-InputObject] <Object> [-Timeout] <TimeSpan> [-ApplianceConnection] <Object>[ [-ApplianceWillReboot] <SwitchParameter>] [<CommonParameters>]HPE OneView utilizes a task subsystem for operations that will take longer than 200ms, and will execute them Asyncrounously. An async task resource object is created and returned to the caller once the request has passed validation.
This blocking cmdlet assists a caller with monitoring a specific task resource, and will wait for the given task to "complete" (get to a terminal state, including error) or timeout. The cmdlet accepts either the task URI or resource object via pipeline.
Once the task is no longer in a running state, the cmlet will return the task resource object. The caller should examine the taskState property/key for the final task status.
-ApplianceConnection <Object>
Aliases [-Appliance]
Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.
Default Value: ${Global:ConnectedSessions} | ? Default
| Aliases | Appliance |
| Required? | true |
| Position? | 2 |
| Default value | (${Global:ConnectedSessions} | ? Default) |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | False |
-ApplianceWillReboot <SwitchParameter>
Internal use t indicate if a task will cause appliance to reboot.
| Aliases | None |
| Required? | false |
| Position? | named |
| Default value | |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
-InputObject <Object>
Aliases [-TaskUri, -Task] The uri of the task resource to wait for.
| Aliases | TaskUri, Task |
| Required? | true |
| Position? | 0 |
| Default value | |
| Accept pipeline input? | true (ByValue) |
| Accept wildcard characters? | False |
-Timeout <TimeSpan>
The timespan to wait for the task to complete. Default is to wait for 20 minutes.
| Aliases | None |
| Required? | true |
| Position? | 1 |
| Default value | $DefaultTimeout |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
System.String
Task URI
HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]
Task resource object
HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]
The finished Task object that includes the task result
-------------------------- EXAMPLE 1 --------------------------Wait-HPOVTaskComplete /rest/tasks/F08EE040-DBA7-4806-BB62-993DD0CB4250 Waiting for task to complete...Task completed successfully!
Wait for task to complete.
-------------------------- EXAMPLE 2 --------------------------Wait-HPOVTaskComplete $task -timeout (New-TimeSpan -minute 10) Waiting for task to complete...Task completed successfully!
Wait for task to complete, modifying the default timeout to 10 minutes.
-------------------------- EXAMPLE 3 --------------------------$svr = Get-HPOVServer "ServerA" $taskResults = New-HPOVServerProfile -name "Profile 1" -server $svr | Wait-HPOVTaskComplete
Retreive the server details for ServerA, create a Server Profile and pass via pipeline the task resource object.
Wait for a task to complete.
Wait-HPOVTaskComplete [-InputObject] <Object> [-Timeout] <TimeSpan> [-ApplianceConnection] <Object> [<CommonParameters>]HPE OneView utilizes a task subsystem for operations that will take longer than 200ms, and will execute them Asyncrounously. An async task resource object is created and returned to the caller once the request has passed validation.
This blocking cmdlet assists a caller with monitoring a specific task resource, and will wait for the given task to "complete" (get to a terminal state, including error) or timeout. The cmdlet accepts either the task URI or resource object via pipeline.
Once the task is no longer in a running state, the cmlet will return the task resource object. The caller should examine the taskState property/key for the final task status.
-ApplianceConnection <Object>
Aliases [-Appliance]
Specify one HPOneView.Appliance.Connection object or Name property value. If Resource object is provided via Pipeline, the ApplianceConnection property of the object will be used.
Default Value: ${Global:ConnectedSessions} | ? Default
| Aliases | Appliance |
| Required? | true |
| Position? | 2 |
| Default value | (${Global:ConnectedSessions} | ? Default) |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | False |
-InputObject <Object>
Aliases [-TaskUri, -Task] The uri of the task resource to wait for.
| Aliases | TaskUri, Task |
| Required? | true |
| Position? | 0 |
| Default value | |
| Accept pipeline input? | true (ByValue) |
| Accept wildcard characters? | False |
-Timeout <TimeSpan>
The timespan to wait for the task to complete. Default is to wait for 20 minutes.
| Aliases | None |
| Required? | true |
| Position? | 1 |
| Default value | $DefaultTimeout |
| Accept pipeline input? | false |
| Accept wildcard characters? | False |
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)
System.String
Task URI
HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]
Task resource object
HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]
The finished Task object that includes the task result
-------------------------- EXAMPLE 1 --------------------------Wait-HPOVTaskComplete /rest/tasks/F08EE040-DBA7-4806-BB62-993DD0CB4250 Waiting for task to complete...Task completed successfully!
Wait for task to complete.
-------------------------- EXAMPLE 2 --------------------------Wait-HPOVTaskComplete $task -timeout (New-TimeSpan -minute 10) Waiting for task to complete...Task completed successfully!
Wait for task to complete, modifying the default timeout to 10 minutes.
-------------------------- EXAMPLE 3 --------------------------$svr = Get-HPOVServer "ServerA" $taskResults = New-HPOVServerProfile -name "Profile 1" -server $svr | Wait-HPOVTaskComplete
Retreive the server details for ServerA, create a Server Profile and pass via pipeline the task resource object.