NAME

Get-HPOVTask

SYNOPSIS

Retrieve list of tasks.

SYNTAX

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

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

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 <String>
The name of the task resource to be returned. All names will match if ommitted.
Aliases Name
Required? false
Position? named
Default value <none>        
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).

Accepted input: System.String (resource Name or URI) or System.Management.Automation.PSCustomObject (resource Object, i.e. $ServerProfile = Get-HPOVProfile 'Server 1')

Aliases <none>
Required? false
Position? 1
Default value <none>        
Accept pipeline input? true (ByValue)
Accept wildcard characters?         false
-ResourceCategory <String>

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? false
Position? named
Default value <none>       
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? false
Position? named
Default value <none>       
Accept pipeline input?         false
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? false
Position? named        
Default value 0     
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).

INPUTS

  • System.String
  • System.Management.Automation.PSCustomObject

OUTPUTS

  • Single Task: System.Management.Automation.PSCustomObject
  • Multiple Tasks: System.Array
The matching task resources.

RELATED LINKS

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.

Last edited Apr 16, 2014 at 4:23 AM by ChrisLynchHP, version 7