Export (0) Print
Expand All
Expand Minimize

Windows HPC Cmdlets for Windows PowerShell

Updated: January 10, 2014

This reference provides cmdlet descriptions and syntax for all HPC cluster-specific cmdlets that are available in Microsoft® HPC Pack 2012 R2, Microsoft® HPC Pack 2012, and HPC Pack 2008 R2. The HPC cmdlets provide an alternative to most actions that you would otherwise perform with command-line commands, HPC Cluster Manager, or HPC Job Manager.

For information about using Windows HPC PowerShell, see Appendix 6: Using HPC PowerShell.

For information about using Windows PowerShell, see Windows PowerShell (TechNet).

For information about the core Windows PowerShell cmdlets, see Windows PowerShell Core Cmdlets.

HPC Cmdlets

The following table lists the cmdlets that HPC Pack provides:

 

Cmdlet Description

Add-HpcDriver

Inserts one or more specified device drivers into all operating system images in the HPC cluster.

Add-HpcGroup

Adds a specified list of one or more nodes to one or more specified node groups.

Add-HpcImage

Loads one or more specified Windows image (.wim) files, and adds the operating system images from those files to the image store for the HPC cluster.

Add-HpcIScsiStorageArray

Adds the Internet SCSI (iSCSI) storage array at the specified management IP address to an HPC cluster.

Add-HpcMember

Adds one or more domain accounts to the HPC cluster as members in a cluster role.

Add-HpcNodeSet

Adds a set of Windows Azure nodes to the HPC cluster.

noteNote
This cmdlet was introduced in HPC Pack 2008 R2 with Service Pack 1 (SP1). It is not supported in previous versions.

Add-HpcPool

Adds the specified resource pool on the HPC cluster.

noteNote
This cmdlet was introduced in HPC Pack 2008 R2 with Service Pack 2 (SP2). It is not supported in previous versions.

Add-HpcTask

Creates a new task and adds it to the specified job.

Add-HpcTest

Adds the custom diagnostic tests that the specified XML file defines to the set of diagnostic tests that administrators can run on the HPC cluster.

Assign-HpcNodeTemplate

Assigns or reapplies a node template to one or more specified compute nodes. As a result, the cmdlet rebuilds the compute nodes with the information from the node template.

Copy-HpcJobTemplate

Copies a job template.

Copy-HpcNodeTemplate

Creates a new node template by making a copy of an existing node template.

Export-HpcDHCPReservations

Saves information about the Dynamic Host Configuration Protocol (DHCP) reservations for the specified nodes to the specified XML file, or for all of the nodes in the cluster if none are specified.

Export-HpcJob

Saves information about a job in an XML file.

Export-HpcJobTemplate

Exports the specified job template to an XML file.

Export-HpcMetric

Exports the specified set of metrics that HPC Cluster Manager uses in the heat maps for the nodes and the monitoring charts to an XML file.

Export-HpcNodeTemplate

Creates an XML-based representation of a node template and stores it in a file.

Export-HpcNodeXml

Exports information about the specified compute nodes to an XML file.

Export-HpcSoaSessionTrace

Copies the Windows Communication Foundation (WCF) log files that contain the traces for the specified service-oriented architecture (SOA) session from each of the compute nodes to a single location so that you can view the log files with Service Trace Viewer.

noteNote
This cmdlet is deprecated and is removed starting in HPC Pack 2012.

Export-HpcTask

Exports the settings for the specified task to a task XML file.

Export-HpcTestResult

Exports the test results for the specified diagnostic test run to the specified directory.

Get-HpcClusterOverview

Gets an overview of some metrics for the specified HPC cluster, including the number of nodes, jobs, and tasks in various states on the HPC cluster.

Get-HpcClusterProperty

Gets the cluster-wide properties for the specified HPC cluster.

Get-HpcDriver

Gets one or more specified device drivers, or gets all of the device drivers for the HPC cluster if you do not specify any device drivers.

Get-HpcGroup

Gets the specified list of one or more node groups.

Get-HpcImage

Gets one or more specified operating system images, or gets all of the operating system images in the image store for the HPC cluster.

Get-HpcIScsiStorageArray

Gets information about or HpcIScsiStorageArray objects for the Internet SCSI (iSCSI) storage arrays with the specified names and management IP addresses, or gets all of the iSCSI storage arrays for the HPC cluster if no names or management IP addresses are specified.

Get-HpcJob

Gets a list of jobs that match the specified criteria, or gets a list of jobs that are running on one or more specified nodes.

Get-HpcJobCredential

Gets the credentials for submitting jobs.

noteNote
This cmdlet was introduced in HPC Pack 2008 R2 with Service Pack 2 (SP2). It is not supported in previous versions.

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.

Get-HpcJobTemplate

Gets information for one or more specified job templates, or for all job templates if none are specified.

Get-HpcJobTemplateAcl

Gets the access control list (ACL) for the specified job template.

Get-HpcMember

Gets one or more specified members for the HPC cluster, or gets all members of one or more specified roles. If you do not specify any members or roles, the Get-HpcMember cmdlet gets all members in all roles for the HPC cluster.

Get-HpcMetric

Gets the specified set of metrics that HPC Cluster Manager uses in the heat maps for the nodes and the monitoring charts.

Get-HpcMetricValue

Gets the current value of the specified metrics that HPC Cluster Manager uses in the heat maps for the nodes and the monitoring charts.

Get-HpcMetricValueHistory

Gets the values that a specified metric had during the specified time period.

Get-HpcNetworkInterface

Gets the network interfaces on the head node that have one or more specified names or one or more specified types.

Get-HpcNetworkTopology

Gets the current network topology for the HPC cluster.

Get-HpcNode

Gets a list of one or more nodes in the HPC cluster that meet the specified criteria.

Get-HpcNodeStateHistory

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

Get-HpcNodeTemplate

Gets one or more specified node templates, or gets all of the node templates for an HPC cluster.

Get-HpcOperation

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

Get-HpcOperationLog

Gets the log and substeps for the specified operation.

Get-HpcPool

Gets the specified resource pool.

noteNote
This cmdlet was introduced in HPC Pack 2008 R2 with Service Pack 2 (SP2). It is not supported in previous versions.

Get-HpcTask

Gets a specified task or subtask for the specified job, or gets a list of all tasks for the specified job.

Get-HpcTest

Gets one or more specified diagnostic tests, or gets all of the diagnostic tests for the HPC cluster if you do not specify any tests.

Get-HpcTestDetail

Gets detailed information about a specified diagnostic test, including the metadata, parameters, environment variables, and commands for the test.

Get-HpcTestResult

Gets the test runs for the specified diagnostic test that meet the specified criteria.

Get-HpcTestResultDetail

Gets detailed information about the results of a specific run for a diagnostic test, including the start and end times for the test, the values specified for the parameters of the test, and the results of the test on each node in the test.

Import-HpcJobTemplate

Imports a job template from an XML file.

Import-HpcMetric

Imports metrics from the specified XML file to create new metrics or overwrite existing metrics that HPC Cluster Manager uses in the heat maps for the nodes and the monitoring charts.

Import-HpcNodeTemplate

Imports one or more node template XML files, and creates new node templates or overwrites existing node templates based on the information in the node template XML files.

Import-HpcNodeXml

Imports nodes from the lists of nodes in one or more specified node XML files, and adds the nodes to the HPC cluster.

Invoke-HpcTest

Runs the specified diagnostic tests on one or more specified nodes.

New-HpcGroup

Creates a new node group with the specified name and description.

New-HpcImage

Creates a new operating system image and adds it to the image store for the HPC cluster.

New-HpcJob

Creates a new job, or creates a new copy of an existing job.

New-HpcNodeTemplate

Creates a new node template and optionally associates an operating system image with the node template.

New-HpcSoftCard

Generates a new HPC soft card certificate.

noteNote
This cmdlet was introduced in HPC Pack 2008 R2 with Service Pack 2 (SP2). It is not supported in previous versions.

Remove-HpcAzureNode

Removes one or more Windows Azure nodes from an HPC cluster.

noteNote
This cmdlet was introduced in HPC Pack 2012 R2. It is not supported in previous versions.

Remove-HpcDriver

Removes one or more specified device drivers.

Remove-HpcGroup

Removes the association between one or more specified node groups and one or more specified nodes.

Remove-HpcImage

Removes one or more specified operating system images from the image store for the HPC cluster.

Remove-HpcIScsiStorageArray

Removes the specified Internet SCSI (iSCSI) storage array from the HPC cluster.

Remove-HpcJobCredential

Deletes the cached credentials for one or more specified users that the job scheduler uses to submit jobs.

Remove-HpcJobTemplate

Deletes a job template from the specified cluster.

Remove-HpcMember

Removes one or more specified members from the HPC cluster or from the specified roles.

Remove-HpcMetric

Removes one or more specified metrics from the set of metrics that HPC Cluster Manager uses in the heat maps for the nodes and the monitoring charts.

Remove-HpcNode

Removes the entry for one or more compute nodes from the database on the head node.

Remove-HpcNodeSet

Removes a set of Windows Azure nodes from an HPC cluster.

noteNote
This cmdlet was introduced in HPC Pack 2008 R2 with Service Pack 1 (SP1). It is not supported in previous versions.

Remove-HpcNodeTemplate

Deletes one or more specified node templates from the HPC cluster.

Remove-HpcPool

Removes the specified HPC resource pool.

noteNote
This cmdlet was introduced in HPC Pack 2008 R2 with Service Pack 2 (SP2). It is not supported in previous versions.

Remove-HpcSoaCredential

Deletes the cached credentials for one or more specified users that service-oriented architecture (SOA) clients use to create SOA sessions.

Remove-HpcSoaSessionTrace

Removes the Windows Communication Foundation (WCF) log files that contain the traces for the specified service-oriented architecture (SOA) session from the compute nodes.

This cmdlet is deprecated and is removed starting in HPC Pack 2012.

Remove-HpcTest

Removes the diagnostic test with the specified alias from the HPC cluster.

Remove-HpcTestCredential

Clears the cached credentials that the HPC Diagnostics Service uses to run diagnostic tests.

Remove-HpcTestResultAlert

Clears the alert icon for the specified diagnostic test runs, or for all diagnostic test runs if none are specified.

Replicate-HpcImage

Copies the base-node operating system image from the specified Windows image (.wim) file to the specified Internet SCSI (iSCSI) storage arrays.

Restart-HpcNode

Restarts one or more compute nodes that are already turned on.

Set-HpcClusterProperty

Sets the specified cluster-wide properties. Cluster-wide properties include parameters, environment variables, installation credentials, credentials to use for sending email notifications, the naming series for new compute nodes, and the Windows Deployment Services mode.

Set-HpcGroup

Changes the name or description of the specified node group.

Set-HpcIScsiStorageArray

Sets the name, description, or IP address of the specified Internet SCSI (iSCSI) storage array for an HPC cluster.

Set-HpcJob

Sets the properties of the specified job.

Set-HpcJobCredential

Sets the credentials for submitting jobs.

Set-HpcJobTemplateAcl

Sets the access control list (ACL) on the specified job template.

Set-HpcNetwork

Sets the network topology and the properties of all of the network interfaces for the HPC cluster.

Set-HpcNode

Changes the properties for one or more nodes, including the description, data center, rack, chassis, location, roles, and product key for the nodes.

Set-HpcNodeState

Sets the state of one or more nodes to online, offline, or rejected.

Set-HpcPool

Sets the weight on the specified resource pool.

noteNote
This cmdlet was introduced in HPC Pack 2008 R2 with Service Pack 2 (SP2). It is not supported in previous versions.

Set-HpcSoaCredential

Sets the credentials for creating service-oriented architecture (SOA) sessions.

Set-HpcTask

Sets the properties for a specified task.

Set-HpcTestCredential

Sets the credentials for running diagnostic tests.

Shutdown-HpcNode

Turns off one or more compute nodes.

Start-HpcNode

Turns on one or more nodes by using an Intelligent Platform Management Interface (IPMI) script.

Start-HpcNodeSet

Starts a set of Windows Azure nodes.

noteNote
This cmdlet was introduced in HPC Pack 2008 R2 with SP1. It is not supported in previous versions.

Stop-HpcAzureNode

Stops one or more Windows Azure nodes.

noteNote
This cmdlet was introduced in HPC Pack 2012 R2). It is not supported in previous versions.

Stop-HpcJob

Cancels one or more specified jobs.

Stop-HpcNodeSet

Stops a set of Windows Azure nodes.

noteNote
This cmdlet was introduced in HPC Pack 2008 R2 with Service Pack 1 (SP1) and is not supported in previous versions.

Stop-HpcOperation

Cancels the specified operation and makes the best possible attempt to revert the operation, if the operation is still running.

Stop-HpcTask

Cancels the specified task or subtask.

Stop-HpcTestResult

Cancels the specified diagnostic test if it is still running.

Submit-HpcJob

Submits or requeues one or more specified jobs to the HPC cluster that you want to run the jobs.

Validate-HpcIScsiStorageArray

Validates that the head node of the HPC cluster can communicate with the specified Internet SCSI (iSCSI) storage array.

Additional references

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft