Get-HpcOperation

Gets one or more specified operations, or gets the operations that meet the specified criteria.

Syntax

	Copy Code
Parameter Set: ByNode Get-HpcOperation [-Definition <String[]> ] [-EndTime <DateTime> ] [-Name <String[]> ] [-Node <HpcNode[]> ] [-NodeName <String[]> ] [-Scheduler <String> ] [-StartTime <DateTime> ] [-State <ChangeState[]> ] [ <CommonParameters>] Parameter Set: ById Get-HpcOperation [[-Id] <String[]> ] [-Scheduler <String> ] [ <CommonParameters>] Parameter Set: ByWorkItem Get-HpcOperation [-Scheduler <String> ] [-WorkItem <HpcWorkItem> ] [ <CommonParameters>]

Copy Code

Parameter Set: ByNode


Get-HpcOperation [-Definition <String[]> ] [-EndTime <DateTime> ] [-Name <String[]> ] [-Node <HpcNode[]> ] [-NodeName <String[]> ] [-Scheduler <String> ] [-StartTime <DateTime> ] [-State <ChangeState[]> ] [ <CommonParameters>]

Parameter Set: ById


Get-HpcOperation [[-Id] <String[]> ] [-Scheduler <String> ] [ <CommonParameters>]

Parameter Set: ByWorkItem


Get-HpcOperation [-Scheduler <String> ] [-WorkItem <HpcWorkItem> ] [ <CommonParameters>]

Detailed Description

Gets one or more specified operations, or gets the operations that meet the specified criteria. If you do not redirect the HpcOperation objects that are the output of the Get-HpcOperation cmdlet to another cmdlet or save the objects to variables, the Get-HpcOperation cmdlet displays information about the operation such as the name, status, and last update time for the operation.

Parameters

-Definition<String[]>

Specifies a list of one or more operation types or definitions for the operations that you want to get.

The valid operation types are: Add Node To Group, Add or Update Counter, Archive Management Data, Archive Scheduler Data, Assign Template, Bring Nodes Online, Check Head Node Configuration, Collect Usage Data, Configuration Update, Delete Operations, Delete Template, Discovery, Edit Nodes, Export Metrics, Export Template, Import Metrics, Import Template, Initialize Cluster, Load Node Configuration, Maintain Nodes, Modify Groups, Reboot Nodes, Reimage Nodes, Reject Nodes, Remove Counters, Remove Node From Group, Remove Nodes, Run Diagnostics, Save Node Configuration, Security Update, Shutdown Nodes, Start Nodes, Take Nodes Offline, Update Global Configuration, Update Network, and Update Template.

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

-EndTime<DateTime>

Specifies a DateTime object or equivalent string that indicates the ending date and time of the period for which you want to get operations. The period covers dates and times that are earlier than the value that the EndTime parameter specifies and later than the value that the Start Time parameter specifies.

Aliases	none
Required?	false
Position?	named
Default Value	the current date and time
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Id<String[]>

Specifies a list of one or more globally unique identifiers (GUIDs) for the operations that you want to get. If you specify the Id parameter, the only other parameters you can specify are the Scheduler parameter and the common parameters.

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

-Name<String[]>

Specifies a list of one or more names for the operations that you want to get.

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

-Node<HpcNode[]>

Specifies a list of one or more HpcNode objects for the nodes on which the operations that you want to get were performed. Use the Get-HpcNode object to get HpcNode objects for the nodes. You cannot specify both the Node and NodeName parameters.

Aliases	none
Required?	false
Position?	named
Default Value	no default
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

-NodeName<String[]>

Specifies a list of the names of one or more nodes on which the operations that you want to get were performed. You cannot specify both the NodeName and Node parameters. This parameter is a filter parameter, so you do not receive an error for specifying a node the does not exist in the HPC cluster as long as you specify at least one node that does exist.

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

-Scheduler<String>

Specifies the host name or IP address of the head node for the cluster on which the operations ran. 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

-StartTime<DateTime>

Specifies a DateTime object or equivalent string that indicates the starting date and time of the period for which you want to get operations. The period covers dates and times that are later than the value that the Start Time parameter specifies and earlier than the value that the EndTime parameter specifies.

Aliases	none
Required?	false
Position?	named
Default Value	the date and time of the first operation
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-State<ChangeState[]>

Specifies a list of one or more states that currently apply to the operations that you want to get. The value states are: Archived, Committed, Executing, Failed, and Reverted.

Aliases	none
Required?	false
Position?	named
Default Value	the combination of all of the states
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WorkItem<HpcWorkItem>

Specifies the HpcWorkItem object that contains the operations that you want to get. An HpcWorkItem object is a collection of operations. The Assign-HpcNodeTemplate cmdlet returns an HpcWorkItem object when you specify the Async parameter for that cmdlet.

Aliases	none
Required?	false
Position?	named
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.

One or more HpcNode objects.

Outputs

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

One or more HpcOperation objects.

Notes

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

Examples

EXAMPLE 1

Gets all of the operations for the HPC cluster.

	Copy Code
Get-HpcOperation

EXAMPLE 2

Gets all of the operations that were performed on the nodes named ComputeNode1 and ComputeNode2 in the last day.

	Copy Code
Get-HpcOperation -NodeName ComputeNode1,ComputeNode2 -StartDate (Get-Date).AddDays(-1) -EndDate (Get-Date)

EXAMPLE 3

Gets all of the operations with the operation type named Reimage Nodes that have a state of failed or reverted.

	Copy Code
Get-HpcOperation -Definition "Reimage Nodes" -State Failed,Reverted

EXAMPLE 4

Gets all of the operations named Deleting metric MyMetric.

	Copy Code
Get-HpcOperation -Name "Deleting metric MyMetric."