This reference provides cmdlet descriptions and syntax for all HPC cluster-specific cmdlets that are used in Windows® HPC Server 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 HPC PowerShell, see Appendix 6: Using HPC PowerShell (http://go.microsoft.com/fwlink/?LinkId=151474).
For information about using Windows PowerShell, see Windows PowerShell (http://go.microsoft.com/fwlink/?LinkId=128257) and Windows PowerShell (TechNet) (http://go.microsoft.com/fwlink/?LinkId=128426).
For information about built-in Windows PowerShell cmdlets, see Windows PowerShell Cmdlet Help Topics (http://go.microsoft.com/fwlink/?LinkId=113277).
HPC Cmdlets
The following table lists the cmdlets that Windows HPC Server 2008 R2 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 the Internet SCSI (iSCSI) storage array at the specified management IP address to an 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. |
|
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. |
|
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 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. |
|
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. |
|
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. |
|
Exports the settings for the specified task to a task XML file. |
|
Exports the test results for the specified diagnostic test run to the specified directory. |
|
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 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. |
|
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. |
|
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 for one or more 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 values that a specified metric had during the specified time period. |
|
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 detailed information about a specified diagnostic test, including the metadata, parameters, environment variables, and commands for the test. |
|
Gets the test runs for the specified diagnostic test that meet the specified criteria. |
|
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. |
|
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 the 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. |
|
Removes the specified Internet SCSI (iSCSI) storage array from 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. |
|
Deletes the cached credentials for one or more specified users that service-oriented architecture (SOA) clients use to create SOA sessions. |
|
Removes the Windows Communication Foundation (WCF) log files that contain the traces for the specified service-oriented architecture (SOA) session from the compute nodes. |
|
Removes the diagnostic test with the specified alias from the HPC cluster. |
|
Clears the cached credentials that the HPC Diagnostics Service uses to run diagnostic tests. |
|
Clears the alert icon for the specified diagnostic test runs, or for all diagnostic test runs if none are specified. |
|
Copies the base-node operating system image from the specified Windows image (.wim) file to the specified Internet SCSI (iSCSI) storage arrays. |
|
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, credentials to use for sending email notifications, 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 name, description, or IP address of the specified Internet SCSI (iSCSI) storage array for an HPC cluster. |
|
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, location, roles, and product key for the nodes. |
|
Sets the state of one or more nodes to online, offline, or rejected. |
|
Sets the credentials for creating service-oriented architecture (SOA) sessions. |
|
Sets the properties for a specified task. |
|
Sets the credentials for running diagnostic tests. |
|
Turns off one or more compute nodes. |
|
Turns on one or more nodes by 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 task or subtask. |
|
Cancels the specified diagnostic test if it is still running. |
|
Submits or requeues one or more specified jobs to the HPC cluster that you want to run the jobs. |
|
Validates that the head node of the HPC cluster can communicate with the specified Internet SCSI (iSCSI) storage array. |
Additional references
Windows HPC Server 2008 and Windows HPC Server 2008 R2 Command Reference (http://go.microsoft.com/fwlink/?LinkId=120724)