Wait HPOVTaskStart - HewlettPackard/POSH-HPEOneView GitHub Wiki

HPE OneView 4.10 Library

Wait-HPOVTaskStart

Wait for a task to start.

SYNTAX

Wait-HPOVTaskStart [-InputObject] <Object> [-resourceName] <String> [-Timeout] <TimeSpan> [-ApplianceConnection] <Object> [<CommonParameters>]

Detailed Description

Wait for the given task to "start" (get beyond validation phase) or timeout.

Parameters

-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? 3
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?    False

-InputObject <Object>

Aliases [-taskuri, -task] The uri or object 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 time or object to wait for the task to start. Default is to wait for 20 minutes.

Aliases None
Required? true
Position? 2
Default value $script:defaultTimeout
Accept pipeline input? false
Accept wildcard characters?    False

-resourceName <String>

Specify the associated ResourceName to the task to display in the Write-Progress -activity parameter.

Aliases None
Required? true
Position? 1
Default value
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)

Input Types

HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]

Task async object

Return Values

HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]

Task async object

Examples

 -------------------------- EXAMPLE 1 --------------------------

$Task = Add-HPOVServer MyiLO.domain.com Administrator password | Wait-HPOVTaskstart

Add a new Server Device to the appliance, wait for the asyncronous task to enter Starting State, and save the task object.

Related Links


Top

HPE OneView 4.00 Library

Wait-HPOVTaskStart

Wait for a task to start.

SYNTAX

Wait-HPOVTaskStart [-InputObject] <Object> [-resourceName] <String> [-Timeout] <TimeSpan> [-ApplianceConnection] <Object> [<CommonParameters>]

Detailed Description

Wait for the given task to "start" (get beyond validation phase) or timeout.

Parameters

-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? 3
Default value (${Global:ConnectedSessions} | ? Default)
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters?    False

-InputObject <Object>

Aliases [-taskuri, -task] The uri or object 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 time or object to wait for the task to start. Default is to wait for 20 minutes.

Aliases None
Required? true
Position? 2
Default value $script:defaultTimeout
Accept pipeline input? false
Accept wildcard characters?    False

-resourceName <String>

Specify the associated ResourceName to the task to display in the Write-Progress -activity parameter.

Aliases None
Required? true
Position? 1
Default value
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)

Input Types

HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]

Task async object

Return Values

HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]

Task async object

Examples

 -------------------------- EXAMPLE 1 --------------------------

$Task = Add-HPOVServer MyiLO.domain.com Administrator password | Wait-HPOVTaskstart

Add a new Server Device to the appliance, wait for the asyncronous task to enter Starting State, and save the task object.

Related Links


Top
⚠️ **GitHub.com Fallback** ⚠️