Get HPOVTask

Library Version 3.00

Library Version 2.00

Library Version 1.20

### HPE OneView 3.00 Library

Get-HPOVTask

Retrieve Task resource(s).

SYNTAX

Get-HPOVTask [-TaskName] <String> [-InputObject] <Object> [-State] <String> [-Count] <Int32> [-ApplianceConnection] <Object> [<CommonParameters>]

Get-HPOVTask [-TaskName] <String> [-ResourceCategory] <String> [-State] <String> [-Count] <Int32> [-ApplianceConnection] <Object> [<CommonParameters>]

Detailed Description

Obtain a collection of task resources which have the specified name and/or state. The returned data will include the task name, owner, state and status.

Parameters

-ApplianceConnection <Object>

Aliases [-Appliance]

Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s). 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?	named
Default value	(${Global:ConnectedSessions} | ? Default)
Accept pipeline input?	true (ByPropertyName)
Accept wildcard characters?	False

-Count <Int32>

Specify the maximum amount of task objects to return. 0 will return all found task objects.

Aliases	None
Required?	true
Position?	named
Default value	0
Accept pipeline input?	false
Accept wildcard characters?	False

-InputObject <Object>

Related resource Name, URI or Object to the task. To be used for filtering tasks specific to a resource object (i.e. Server Profile).

Aliases	Resource
Required?	true
Position?	named
Default value
Accept pipeline input?	true (ByValue)
Accept wildcard characters?	False

-ResourceCategory <String>

Aliases [-Category] Specify the Resource Category to filter task results to. Cannot be combined with Resource parameter.

Some examples are:

• ethernet-networks
• fc-networks
• power-devices
• unmanaged-devices
• server-profiles
• server-hardware
• enclosures
• enclosure-groups
• interconnects
• logical-interconnects
• logical-interconnect-groups
• appliance
• firmware-drivers

Aliases	Category
Required?	true
Position?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

-State <String>

The state of the task resource a to be returned. May be one of the following strings:

• Unknown
• New
• Running
• Suspended
• Terminated
• Killed
• Completed
• Error
• Warning

All states will match if omitted. All tasks will be returned if both names and state are omitted.

Aliases	None
Required?	true
Position?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

-TaskName <String>

Aliases [-Name] The name of the task resource to be returned. All names will match if omitted.

Aliases	name
Required?	true
Position?	named
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 ] Resource Object to retrieve task resources of

Return Values

HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject] nSingle Task resource _**System.Collections.ArrayList <HPOneView.Appliance.TaskResource>**_ nMultiple Task resources or formatted table list of tasks The matching task resources. `n

Examples

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

PS C:\> $tasks = Get-HPOVTask -state Error

Return all the tasks with a taskState='Error'

 -------------------------- EXAMPLE 2 --------------------------

PS C:\> Get-HPOVServerProfile "Server 1" | Get-HPOVTask -State Completed

Return completed (successful) tasks associated with the 'Server 1' Server Profile.

 -------------------------- EXAMPLE 3 --------------------------

PS C:\> Get-HPOVTask -count 10

Display the 10 most recent tasks from the specified appliance connection.

Related Links

• [Wait-HPOVTaskAccepted] (https://github.com/HewlettPackard/POSH-HPOneView/wiki/Wait-HPOVTaskAccepted)
• [Wait-HPOVTaskStart] (https://github.com/HewlettPackard/POSH-HPOneView/wiki/Wait-HPOVTaskStart)
• [Wait-HPOVTaskComplete] (https://github.com/HewlettPackard/POSH-HPOneView/wiki/Wait-HPOVTaskComplete)

---

Top

### HPE OneView 2.00 Library

Get-HPOVTask

Retrieve Task resource(s).

SYNTAX

Get-HPOVTask [-TaskName] <String> [-Resource] <Object> [-State] <String> [-Count] <Int32> [-ApplianceConnection] <Object> [<CommonParameters>]

Get-HPOVTask [-TaskName] <String> [-ResourceCategory] <String> [-State] <String> [-Count] <Int32> [-ApplianceConnection] <Object> [<CommonParameters>]

Detailed Description

Obtain a collection of task resources which have the specified name and/or state. The returned data will include the task name, owner, state and status.

Parameters

-ApplianceConnection <Object>

Aliases [-Appliance]

Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s). 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?	named
Default value	(${Global:ConnectedSessions} | ? Default)
Accept pipeline input?	true (ByPropertyName)
Accept wildcard characters?	False

-Count <Int32>

Specify the maximum amount of task objects to return. 0 will return all found task objects.

Aliases	None
Required?	true
Position?	named
Default value	0
Accept pipeline input?	false
Accept wildcard characters?	False

-Resource <Object>

Related resource Name, URI or Object to the task. To be used for filtering tasks specific to a resource object (i.e. Server Profile).

Aliases	None
Required?	true
Position?	named
Default value
Accept pipeline input?	true (ByValue)
Accept wildcard characters?	False

-ResourceCategory <String>

Aliases [-Category] Specify the Resource Category to filter task results to. Cannot be combined with Resource parameter.

Some examples are:

* ethernet-networks
* fc-networks
* power-devices
* unmanaged-devices
* server-profiles
* server-hardware
* enclosures
* enclosure-groups
* interconnects
* logical-interconnects
* logical-interconnect-groups
* appliance
* firmware-drivers

Aliases	Category
Required?	true
Position?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

-State <String>

The state of the task resource a to be returned. May be one of the following strings:

* Unknown
* New
* Running
* Suspended
* Terminated
* Killed
* Completed
* Error
* Warning

All states will match if omitted. All tasks will be returned if both names and state are omitted.

Aliases	None
Required?	true
Position?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	False

-TaskName <String>

Aliases [-Name] The name of the task resource to be returned. All names will match if omitted.

Aliases	name
Required?	true
Position?	named
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

**System.String ** Resource Name or URI

**System.Management.Automation.PSCustomObject ** Resource Object to retrieve task resources of.

Return Values

HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject] `nSingle Task resource.

System.Collections.ArrayList <HPOneView.Appliance.TaskResource> `nMultiple Task resources or formatted table list of tasks.

The matching task resources. `n The matching task resources.

Examples

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

PS C:\> $tasks = Get-HPOVTask -state Error

Return all the tasks with a taskState='Error'

 -------------------------- EXAMPLE 2 --------------------------

PS C:\> Get-HPOVServerProfile "Server 1" | Get-HPOVTask -State Completed

Return completed (successful) tasks associated with the 'Server 1' Server Profile.

 -------------------------- EXAMPLE 3 --------------------------

PS C:\> Get-HPOVTask -count 10

Display the 10 most recent tasks from the specified appliance connection.

Related Links

• [Wait-HPOVTaskAccepted] (https://github.com/HewlettPackard/POSH-HPOneView/wiki/Wait-HPOVTaskAccepted)
• [Wait-HPOVTaskStart] (https://github.com/HewlettPackard/POSH-HPOneView/wiki/Wait-HPOVTaskStart)
• [Wait-HPOVTaskComplete] (https://github.com/HewlettPackard/POSH-HPOneView/wiki/Wait-HPOVTaskComplete)

---

Top

### HPE OneView 1.20 Library

Get-HPOVTask

Retrieve Task resource(s).

SYNTAX

Get-HPOVTask[ [-TaskName] <TaskName>][ [-Resource] <Resource>][ [-State] <State>][ [-Count] <Count>][ [-List] <List>] [<CommonParameters>]

Get-HPOVTask[ [-TaskName] <TaskName>][ [-ResourceCategory] <ResourceCategory>][ [-State] <State>][ [-Count] <Count>][ [-List] <List>] [<CommonParameters>]

Detailed Description

Obtain a collection of task resources which have the specified name and/or state. The returned data will include the task name, owner, state and status.

Parameters

-TaskName <TaskName>

Aliases [-Name] The name of the task resource to be returned. All names will match if omitted.

Aliases	None.
Required?	false
Position?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	false

-Resource <Resource>

Related resource Name, URI or Object to the task. To be used for filtering tasks specific to a resource object (i.e. Server Profile).

Aliases	None.
Required?	false
Position?	named
Default value
Accept pipeline input?	true (ByValue)
Accept wildcard characters?	false

-ResourceCategory <ResourceCategory>

Aliases [-Category] Specify the Resource Category to filter task results to. Cannot be combined with Resource parameter.

Some examples are:

• ethernet-networks
• fc-networks
• power-devices
• unmanaged-devices
• server-profiles
• server-hardware
• enclosures
• enclosure-groups
• interconnects
• logical-interconnects
• logical-interconnect-groups
• appliance
• firmware-drivers

Aliases	None.
Required?	false
Position?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	false

-State <State>

The state of the task resource a to be returned. May be one of the following strings:

• Unknown • New • Running • Suspended • Terminated • Killed • Completed • Error • Warning

All states will match if omitted. All tasks will be returned if both names and state are omitted.

Aliases	None.
Required?	false
Position?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	false

-Count <Count>

Specify the maximum amount of task objects to return. 0 will return all found task objects.

Aliases	None.
Required?	false
Position?	named
Default value	0
Accept pipeline input?	false
Accept wildcard characters?	false

-List <List>

Deprecated. Display task resources in a formatted table.

Aliases	None.
Required?	false
Position?	named
Default value	False
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

**System.String ** Resource Name or URI **System.Management.Automation.PSCustomObject ** Resource Object to retrieve task resources of.

Return Values

HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject] `nSingle Task resource.

System.Array `nMultiple Task resources or formatted table list of tasks.

The matching task resources. `n The matching task resources.

Examples

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

PS C:\> $tasks = Get-HPOVTask -state Error

Return all the tasks with a taskState='Error'

 -------------------------- EXAMPLE 2 --------------------------

PS C:\> Get-HPOVProfile "Server 1" | Get-HPOVTask -State Completed

Return completed (successful) tasks associated with the 'Server 1' Server Profile.

 -------------------------- EXAMPLE 3 --------------------------

PS C:\> Get-HPOVTask -count 10

Display the 10 most recent tasks.

Related Links

• [Wait-HPOVTaskAccepted] (https://github.com/HewlettPackard/POSH-HPOneView/wiki/Wait-HPOVTaskAccepted)
• [Wait-HPOVTaskStart] (https://github.com/HewlettPackard/POSH-HPOneView/wiki/Wait-HPOVTaskStart)
• [Wait-HPOVTaskComplete] (https://github.com/HewlettPackard/POSH-HPOneView/wiki/Wait-HPOVTaskComplete)

---

Top