Get-HpcNodeStateHistory

Retrieves the history of changes to the state of the nodes in the HPC cluster for the specified time period.

Syntax

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

Copy Code

Parameter Set: Default


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

Detailed Description

Retrieves the history of changes to the state of the nodes in the HPC cluster for the specified time period. The time period is the period 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 history of node states to a database. You can then use this database to track node availability.

Parameters

-EndDate<DateTime>

Specifies a DateTime object for the end date and time for the time period for which you want to retrieve the history of changes to the node states. 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 for which you want to get the history of changes to the state of the nodes. 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?	false

-StartDate<DateTime>

Specifies a DateTime object for the start date and time for the time period for which you want to retrieve the history of changes to the node states. 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.

An array of HpcNodeHistory objects.

Notes

The time stamps in the history of node states are in the time zone of the local computer instead of the time zone of the head node for the cluster. Run this cmdlet on a computer located in the same time zone as head node to get consistent results.
You must be a cluster administrator to run this cmdlet successfully.

Examples

EXAMPLE 1

Retrieves the history of changes to the node states for the past day. Run this cmdlet daily at midnight or some other appropriate time to update the database you use to track node availability.

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