Get-HpcJobHistory

Gets the job history data for all finished, canceled, and failed jobs for the specified time period. You can export this information to a database and create and run reports on the information.

Syntax

	Copy Code
Parameter Set: Default Get-HpcJobHistory [-StartDate] <DateTime> [-EndDate] <DateTime> [-Scheduler <String> ] [ <CommonParameters>]

Copy Code

Parameter Set: Default


Get-HpcJobHistory [-StartDate] <DateTime> [-EndDate] <DateTime> [-Scheduler <String> ] [ <CommonParameters>]

Detailed Description

Gets the job history data for all finished, canceled, and failed jobs for the specified time period. You can export this information to a database and create and run reports on the information. The time period is on and after the specified start date and time and before the specified end date and time.

You can schedule this cmdlet to run daily and export the job history to a database. You can then use this database to track job history.

Parameters

-EndDate<DateTime>

Specifies a DateTime object or a date string that is compatible with the current date format on your computer for the end date and time for the time period for which you want to retrieve the job history. Use the Get-Date cmdlet to get a DateTime object for a date and time.

Aliases	none
Required?	true
Position?	2
Default Value	no default
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Scheduler<String>

Specifies the host name or IP address of the head node for the cluster on which ran the jobs for which you want to get history data. The value must be a valid computer name or IP address. If you do not specify the Scheduler parameter, this cmdlet uses the scheduler on the head node that the CCP_SCHEDULER environment variable specifies. To set this environment variable, run the following cmdlet:

Set-Content Env:CCP_SCHEDULER <head_node_name>

Aliases	none
Required?	false
Position?	named
Default Value	%CCP_SCHEDULER%
Accept Pipeline Input?	false
Accept Wildcard Characters?

-StartDate<DateTime>

Specifies a DateTime object or a date string that is compatible with the current date format on your computer for the start date and time for the time period for which you want to retrieve the job history. Use the Get-Date cmdlet to get a DateTime object for a date and time.

Aliases	none
Required?	true
Position?	1
Default Value	no default
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

None.

Outputs

The output type is the type of the objects that the cmdlet emits.

One or more HpcJobHistory objects.

Notes

You must be a cluster administrator to run this cmdlet successfully.

Examples

EXAMPLE 1

Gets the job history for the past day. Run this cmdlet daily at midnight or some other appropriate time to update the database that you use to track job history.

	Copy Code
Get-HpcJobHistory -StartDate (Get-Date).AddDays(-1) -EndDate (Get-Date)

EXAMPLE 2

Gets the job history for the period on and after 7/12/2008 and before 7/23/2008.

	Copy Code
Get-HpcJobHistory -StartDate "7/12/2008 12:00:00 AM" -EndDate "7/23/2008 12:00:00 AM"