.png)
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 |
|---|---|
|
Inserts one or more specified device drivers into all operating system images in the HPC cluster. |
|
|
Adds a specified list of one or more nodes to one or more specified node groups. |
|
|
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. |
|
|
Adds one or more specified users or administrators to the HPC cluster. |
|
|
Creates a new task and adds it to the specified job. |
|
|
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. |
|
|
Copies a job template. |
|
|
Creates a new node template by making a copy of an existing node template. |
|
|
Saves information about a job in an XML file. |
|
|
Exports the specified job template to an XML file. |
|
|
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. |
|
|
Creates an XML-based representation of a node template and stores it in a file. |
|
|
Exports information about the specified compute nodes to an XML file. |
|
|
Exports the settings for the specified task to a task XML file. |
|
|
Exports the test result of a specified diagnostic test run to an HTML file. |
|
|
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. |
|
|
Gets the cluster-wide properties for the specified HPC cluster. |
|
|
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. |
|
|
Gets the specified list of one or more node groups. |
|
|
Gets one or more specified operating system images, or gets all of the operating system images in the image store for the HPC cluster. |
|
|
Gets a list of jobs that match the specified criteria. |
|
|
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. |
|
|
Gets information or an HpcJobTemplate object for a set of specified job templates, or for all job templates if none are specified. |
|
|
Gets the access control list (ACL) for the specified job template. |
|
|
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. |
|
|
Gets the specified set of metrics that HPC Cluster Manager uses in the heat maps for the nodes and the monitoring charts. |
|
|
Gets the current value of the specified metrics that HPC Cluster Manager uses in the heat maps for the nodes and the monitoring charts. |
|
|
Gets the network interfaces on the head node that have one or more specified names or one or more specified types. |
|
|
Gets the current network topology for the HPC cluster. |
|
|
Gets a list of one or more nodes in the HPC cluster that meet the specified criteria. |
|
|
Retrieves the history of changes to the state of the nodes in the HPC cluster for the specified time period. |
|
|
Gets one or more specified node templates, or gets all of the node templates for an HPC cluster. |
|
|
Gets one or more specified operations, or gets the operations that meet the specified criteria. |
|
|
Gets the log and substeps for the specified operation. |
|
|
Gets a specified task or subtask for the specified job, or gets a list of all tasks for the specified job. |
|
|
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. |
|
|
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. |
|
|
Imports a job template from an XML file. |
|
|
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. |
|
|
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. |
|
|
Imports nodes from the lists of nodes in one or more specified node XML files, and adds the nodes to the HPC cluster. |
|
|
Runs one or more specified diagnostic tests on one or more specified nodes. |
|
|
Creates a new node group with the specified name and description. |
|
|
Creates a new operating system image and adds it to the image store for the HPC cluster. |
|
|
Creates a new job, or creates a new copy of an existing job. |
|
|
Creates a new node template and optionally associates an operating system image with the node template. |
|
|
Removes one or more specified device drivers. |
|
|
Removes the association between one or more specified node groups and one or more specified nodes. |
|
|
Removes one or more specified operating system images from the image store for the HPC cluster. |
|
|
Deletes the cached credentials for one or more specified users that the job scheduler uses to submit jobs. |
|
|
Deletes a job template from the specified cluster. |
|
|
Removes one or more specified members from the HPC cluster or from the specified roles. |
|
|
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. |
|
|
Removes the entry for one or more compute nodes from the database on the head node. |
|
|
Deletes one or more specified node templates from the HPC cluster. |
|
|
Restarts one or more compute nodes that are already turned on. |
|
|
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. |
|
|
Changes the name or description of the specified node group. |
|
|
Sets the properties of the specified job. |
|
|
Sets the credentials for submitting jobs. |
|
|
Sets the access control list (ACL) on the specified job template. |
|
|
Sets the network topology and the properties of all of the network interfaces for the HPC cluster. |
|
|
Changes the properties for one or more nodes, including the description, data center, rack, chassis, roles, and product key for the nodes. |
|
|
Sets the state of one or more nodes to online, offline, or rejected. |
|
|
Sets the properties for a specified task. |
|
|
Turns off one or more compute nodes. |
|
|
Turns on one or more nodes using an Intelligent Platform Management Interface (IPMI) script. |
|
|
Cancels one or more specified jobs. |
|
|
Cancels the specified operation and makes the best possible attempt to revert the operation, if the operation is still running. |
|
|
Cancels the specified diagnostic test if it is still running. |
|
|
Submits or requeues one or more specified jobs to run the jobs. |
