HPCPack2016
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 HPC PowerShell, see Appendix 6: Using HPC PowerShell in the TechNet library.
For information about using Windows PowerShell, see Windows PowerShell (TechNet) in TechNet.
For information about built-in Windows PowerShell cmdlets, see Windows PowerShell Core Cmdlets in TechNet.
HPCPack2016
| Add-HpcBatchPool |
Adds an Azure Batch pool to the HPC cluster. |
| Add-HpcGroup |
Adds nodes to node groups. |
| Add-HpcImage |
Adds an operating system image to the image store for an HPC cluster. |
| Add-HpcIScsiStorageArray |
Adds the iSCSI storage array at the specified management IP address to an HPC cluster. |
| Add-HpcLinuxNode |
Adds Linux node to the HPC cluster. This is only used for testing purposes. |
| Add-HpcMember |
Adds a domain account to the HPC cluster as a member in a cluster role. |
| Add-HpcNodeSet |
Adds a set of Azure nodes to the HPC cluster. |
| Add-HpcNonDomainComputeNode |
Adds a non-domain-joined compute node to the HPC cluster. This cmdlet is only used for testing purposes. |
| Add-HpcPool |
Adds a resource pool to an HPC cluster. |
| Add-HpcTask |
Creates a task and adds it to a job. |
| Add-HpcTest |
Adds custom diagnostic tests to the set of diagnostic tests that administrators can run on the HPC cluster. |
| Add-HpcUnManagedNode |
Adds unmanaged compute resources to the cluster as a compute node. |
| Assign-HpcNodeTemplate |
Assigns or reapplies a node template to a node. |
| Copy-HpcJobTemplate |
Copies a job template. |
| Copy-HpcNodeTemplate |
Creates a node template by making a copy of an existing node template. |
| Export-HpcDHCPReservations |
Saves information about the DHCP reservations. |
| Export-HpcJob |
Saves information about a job in an XML file. |
| Export-HpcJobTemplate |
Exports a 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 compute nodes to an XML file. |
| Export-HpcTask |
Exports the settings for a task to an XML file. |
| Export-HpcTestResult |
Exports the test results for the specified diagnostic test run to the specified directory. |
| Get-HpcBatchPoolStartTask |
Gets the start task result from an Azure Batch pool if a start task is specified in an Azure Batch pool template. |
| 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 an HPC cluster. |
| Get-HpcClusterRegistry |
Gets configuration properties related to HPC Pack which are stored in the Service Fabric property store. |
| Get-HpcDriver - Gets device drivers for HPC cluster |
Gets device drivers. |
| Get-HpcGroup |
Gets node groups. |
| Get-HpcImage |
Gets operating system images for an HPC cluster. |
| Get-HpcIScsiStorageArray |
Gets HpcIScsiStorageArray objects. |
| Get-HpcJob |
Gets jobs. |
| Get-HpcJobCredential |
Gets the credentials for submitting jobs. |
| Get-HpcJobHistory |
Gets the job history data for all finished, canceled, and failed jobs. |
| Get-HpcJobTemplate |
Gets information for one or more specified job templates, or for all job templates if none are specified. |
| Get-HpcJobTemplateAcl |
Gets the ACL for a job template. |
| Get-HpcLogUploaderConfig |
Gets the configuration of the LogUploaderAgent. |
| Get-HpcMember |
Gets a member for the HPC cluster. |
| Get-HpcMetric |
Gets metrics that HPC Cluster Manager uses in the heat maps for the nodes and the monitoring charts. |
| Get-HpcMetricValue |
Gets the current value of metrics that HPC Cluster Manager uses in heat maps for nodes and monitoring charts. |
| Get-HpcMetricValueHistory |
Gets the values for a specified metric during the specified time period. |
| Get-HpcNetworkInterface |
Gets network interfaces on the head node. |
| Get-HpcNetworkTopology |
Gets the current network topology for the HPC cluster. |
| Get-HpcNode |
Gets nodes in the HPC cluster. |
| Get-HpcNodeStateHistory |
Gets the history of changes to the state of the nodes in the HPC cluster for the specified time period. |
| Get-HpcNodeTemplate |
Gets a node template for an HPC cluster. |
| Get-HpcOperation |
Gets an operation. |
| Get-HpcOperationLog |
Gets the log and substeps for the specified operation. |
| Get-HpcPool |
Gets a resource pool. |
| Get-HpcTask |
Gets a task or subtask for a job. |
| Get-HpcTest |
Gets diagnostic tests for the HPC cluster. |
| Get-HpcTestDetail |
Gets detailed information about a diagnostic test. |
| Get-HpcTestResult |
Gets test runs. |
| Get-HpcTestResultDetail |
Gets detailed information about the results of a run for a diagnostic 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 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 node group. |
| New-HpcImage |
Creates an operating system image and adds it to the image store for an HPC cluster. |
| New-HpcJob |
Creates a job, or creates a copy of an existing job. |
| New-HpcNodeTemplate |
Creates a node template and optionally associates an operating system image with the node template. |
| New-HpcSoftCard |
Generates an HPC soft card certificate. |
| Remove-HpcAzureNode |
Removes one or more Azure nodes from an HPC cluster. |
| Remove-HpcDriver - Remove a device driver in HPC Pack 2016 |
Removes a device driver. |
| Remove-HpcGroup |
Removes the association between one or more specified node groups and one or more specified nodes. |
| Remove-HpcImage |
Removes operating system images from the image store for an HPC cluster. |
| Remove-HpcIScsiStorageArray |
Removes the specified iSCSI storage array from the HPC cluster. |
| Remove-HpcJobCredential |
Deletes cached credentials that the job scheduler uses to submit jobs. |
| Remove-HpcJobTemplate |
Deletes a job template. |
| Remove-HpcMember |
Removes members from the HPC cluster or from specified roles. |
| Remove-HpcMetric |
Removes 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 nodes from the HPC cluster management database. |
| Remove-HpcNodeSet |
Removes a set of Azure nodes from an HPC cluster. |
| Remove-HpcNodeTemplate |
Deletes node templates from the HPC cluster. |
| Remove-HpcPool |
Removes a resource pool. |
| Remove-HpcSoaCredential |
Deletes the cached credentials for users that SOA clients use to create SOA sessions. |
| 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 diagnostic test runs. |
| Remove-HpcTokenCache |
Removes the client Azure Active Directory token cache used for job submission. |
| Replicate-HpcImage |
Copies a base-node operating system image from a Windows image (.wim) file to an Internet SCSI (iSCSI) storage array. |
| Restart-HpcNode |
Restarts a node that is already turned on. |
| Set-HpcClusterProperty |
Sets cluster-wide properties. |
| Set-HpcClusterRegistry |
Sets configuration properties related to HPC Pack which are stored in the Service Fabric property store. |
| Set-HpcGroup |
Modifies the name or description of a node group. |
| Set-HpcIScsiStorageArray |
Sets an 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 ACL on a job template. |
| Set-HpcLogUploaderConfig |
Sets the configuration of the LogUploaderAgent. |
| 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 a node. |
| Set-HpcNodeState |
Sets the state a node. |
| Set-HpcPool |
Sets the weight of a resource pool. |
| Set-HpcSoaCredential |
Sets the credentials for creating SOA sessions. |
| Set-HpcTask |
Sets the properties for a task. |
| Set-HpcTestCredential |
Sets the credentials for running diagnostic tests. |
| Set-HpcTokenCache |
Sets the client Azure Active Directory token cache for job submission. |
| Shutdown-HpcNode |
Turns off one or more nodes. |
| Start-HpcAzureNode |
Starts Azure nodes. |
| Start-HpcBatchPool |
Starts an Azure Batch pool in the HPC cluster. |
| Start-HpcNode |
Turns on nodes by using an Intelligent Platform Management Interface (IPMI) script. |
| Start-HpcNodeSet |
Starts a set of Azure nodes. |
| Stop-HpcAzureNode |
Stops Azure nodes. |
| Stop-HpcBatchPool |
Stop an Azure Batch pool in an HPC cluster. |
| Stop-HpcJob |
Cancels a job. |
| Stop-HpcNodeSet |
Stops a set of Azure nodes. |
| 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 a task or subtask. |
| Stop-HpcTestResult |
Cancels a diagnostic test if it is still running. |
| Submit-HpcJob |
Submits or re-queues jobs to the HPC cluster. |
| Validate-HpcIScsiStorageArray |
Validates that the head node of the HPC cluster can communicate with an iSCSI storage array. |