Get-HpcNodeStateHistory
Gets the history of changes to the state of the nodes in the HPC cluster for the specified time period.
Syntax
AllNode (Default)
Get-HpcNodeStateHistory
[-StartDate] <DateTime>
[-EndDate] <DateTime>
[-ClusterConnectionString <String[]>]
[-Scheduler <String[]>]
[<CommonParameters>]
Name
Get-HpcNodeStateHistory
[-StartDate] <DateTime>
[-EndDate] <DateTime>
[-Name <String[]>]
[-ClusterConnectionString <String[]>]
[-Scheduler <String[]>]
[<CommonParameters>]
Node
Get-HpcNodeStateHistory
[-StartDate] <DateTime>
[-EndDate] <DateTime>
[-Node <HpcNode[]>]
[-ClusterConnectionString <String[]>]
[-Scheduler <String[]>]
[<CommonParameters>]
Description
The Get-HpcNodeStateHistory cmdlet gets 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.
Examples
Example 1: Get the history of node state changes
PS C:\>Get-HpcNodeStateHistory -StartDate (Get-Date).AddDays(-1) -EndDate (Get-Date)
This command gets the history of changes to the node state for the previous day. Run this cmdlet daily at midnight or other appropriate time to update the database you use to track node availability.
Parameters
-ClusterConnectionString
Specifies an array of cluster connection strings for the cluster to which you want to add the device drivers.
The value format is host1,host2,host3.
If you do not specify the ClusterConnectionString parameter, this cmdlet uses the connection string on the head node that the CCP_CONNECTIONSTRING environment variable specifies.
To set this environment variable, run the following cmdlet: Set-Content Env: CCP_CONNECTIONSTRING \<head_node_name\>.
This parameter was introduced in HPC Pack 2016.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EndDate
Specifies a DateTime object for the end date and time for the time period for which you want to get the history of changes to the node states. Use the Get-Date cmdlet to get a DateTime object for a date and time.
Parameter properties
| Type: | DateTime |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies an array of names for the nodes for which you want to retrieve the history of changes. You cannot specify both the Name and Node parameters.
This parameter was introduced in HPC Pack 2012. It is not supported in previous versions.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Name
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Node
Specifies an array of HpcNode objects for the nodes for which you want to get the history of changes. You cannot specify both the Name and Node parameters.
This parameter was introduced in HPC Pack 2012. It is not supported in previous versions.
Parameter properties
| Type: | HpcNode[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Node
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Scheduler
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\>
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-StartDate
Specifies a DateTime object for the start date and time for the time period for which you want to get the history of changes to the node states. Use the Get-Date cmdlet to get a DateTime object for a date and time.
Parameter properties
| Type: | DateTime |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
None
Outputs
HpcNodeHistory
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.