Export (0) Print
Expand All
1 out of 1 rated this helpful - Rate this topic

Windows HPC Server 2008 PowerShell Reference

Applies To: Windows HPC Server 2008

This reference provides cmdlet descriptions and syntax for all HPC cluster-specific PowerShell cmdlets used in Windows® HPC Server 2008. The HPC PowerShell cmdlets provide another alternative to most actions that you would otherwise perform with command-line commands, HPC Cluster Manager, or HPC Job Manager.

For information about using HPC PowerShell, see Appendix 6: Using HPC PowerShell. For information about using PowerShell in general, see Windows PowerShell, Windows PowerShell 1.0 Documentation Pack and Windows PowerShell (TechNet). For information about built-in PowerShell cmdlets, see Windows PowerShell Cmdlet Help Topics.

The following table lists the PowerShell cmdlets that Windows HPC Server 2008 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-HpcMember

Adds one or more specified users or administrators to the HPC cluster.

Add-HpcTask

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

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-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-HpcTask

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

Export-HpcTestResult

Exports the test result of a specified diagnostic test run to an HTML file.

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-HpcJob

Gets a list of jobs that match the specified criteria.

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 or an HpcJobTemplate object for a set of 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 users and administrators for the HPC cluster, or gets all members of one or more specified roles. If you do not specify any users, administrators, or roles, the Get-HpcMember cmdlet gets all of the users and administrators 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-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-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-HpcTestResult

Gets the status of test results for the specified diagnostic test that meet the specified criteria, or gets the status of test results for diagnostic tests that failed on the specified node that meet the specified criteria.

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 one or more 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.

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-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-HpcNodeTemplate

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

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, 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-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, roles, and product key for the nodes.

Set-HpcNodeState

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

Set-HpcTask

Sets the properties for a specified task.

Shutdown-HpcNode

Turns off one or more compute nodes.

Start-HpcNode

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

Stop-HpcJob

Cancels one or more specified jobs.

Stop-HpcOperation

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

Stop-HpcTestResult

Cancels the specified diagnostic test if it is still running.

Submit-HpcJob

Submits or requeues one or more specified jobs to run the jobs.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.