Skip to main content
Get-HpcClusterProperty

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

Syntax

Get-HpcClusterProperty [-Environment] [-Scheduler <string>] [[-Name] <string>] [<CommonParameters>]

Get-HpcClusterProperty [-InstallCredential] [-Scheduler <string>] [<CommonParameters>]

Get-HpcClusterProperty [-NodeNamingSeries] [-Scheduler <string>] [<CommonParameters>]

Get-HpcClusterProperty [-Parameter] [-Scheduler <string>] [[-Name] <string>] [<CommonParameters>]

Get-HpcClusterProperty [-Scheduler <string>] [-WDSMode] [<CommonParameters>]

Detailed Description

Gets the cluster-wide properties for the specified HPC cluster. Cluster-wide properties include parameters, environment variables, installation credentials, the naming series for new compute nodes, and the Windows Deployment Services mode.

Parameters

-Environment

Gets the values of cluster-wide environment variables. To get the value of a specific cluster-wide environment variable, use the Name parameter in addition to the Environment parameter.

The CCP_CLUSTER_NAME, CCP_MPI_NETMASK, and WCF_NETWORKPREFIX environment variables are present by default. The CCP_CLUSTER_NAME environment variable specifies the name of the cluster, which is the same as the name of the computer that serves as the head node. The CCP_MPI_NETMASK environment variable specifies the network mask for the network interface that the Message Passing Interface (MPI) process uses. The WCF_NETWORKPREFIX environment variable specifies the prefix for the network that the Windows Communication Foundation (WCF) broker and service use for internal traffic.

You can set the value of these environment variables and create your own environment variables by using the Set-HpcClusterProperty cmdlet.

You cannot specify both the Environment parameter and any of the following parameters: InstallCredential, NodeNamingSeries, Parameter, and WDSMode.

 

Required?

false

Position?

named

Default Value

not applicable

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InstallCredential

Gets the credentials used for installing new compute nodes and for running diagnostic tests.

You cannot specify both the InstallCredential parameter and any of the following parameters: Environment, NodeNamingSeries, Parameter, and WDSMode.

 

Required?

false

Position?

named

Default Value

not applicable

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name <string>

Specifies the name of the parameter or environment variable for which you want to get the value. You must also specify either the Environment or Parameter parameter when you specify the Name parameter.

You cannot specify both the Name parameter and any of the following parameters: InstallCredential, NodeNamingSeries, and WDSMode.

 

Required?

false

Position?

1

Default Value

no default

Accept Pipeline Input?

false

Accept Wildcard Characters?

true

-NodeNamingSeries

Gets the naming series used to generate names for new compute nodes. For example, a naming series of ComputeNode%01% generates a series of 99 node names from ComputeNode01 to ComputeNode99.

You cannot specify both the NodeNameSeries parameter and any of the following parameters: Environment, InstallCredential, Parameter, and WDSMode.

 

Required?

false

Position?

named

Default Value

not applicable

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Parameter

Gets the values of configuration parameters for the HPC cluster. To get the value of a specific configuration parameter, use the Name parameter in addition to the Parameter parameter. For information about the configuration parameters for an HPC cluster, see the Help for the Set-HpcClusterProperty cmdlet.

You cannot specify both the Parameter parameter and any of the following parameters: Environment, InstallCredential, NodeNamingSeries, and WDSMode.

 

Required?

false

Position?

named

Default Value

not applicable

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Scheduler <string>

Specifies the host name or IP address of the head node for the cluster for which you want to get information. The value must be a valid computer name or IP address. If you do not specify the Scheduler parameter, this cmdlet uses the scheduler on the head node that the CCP_SCHEDULER environment variable specifies. To set this environment variable, run the following cmdlet:

Set-Content Env:CCP_SCHEDULER <head_node_name>

 

Required?

false

Position?

named

Default Value

%CCP_SCHEDULER%

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WDSMode

Gets the value of the Windows Deployment Services setting that indicates whether the head node responds to all Pre-Boot Execution Environment (PXE) requests, or only the requests that come from existing compute nodes. The value is AutoCapture if the head node responds to all requests, or IgnoreUnknown if the head node responds only to requests from existing compute nodes.

You cannot specify both the WDSMode parameter and any of the following parameters: Environment, InstallCredential, NodeNamingSeries, and Parameter.

 

Required?

false

Position?

named

Default Value

not applicable

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.

Input and Return Types

The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet emits.

 

Input Type

None.

Return Type

An HpcVariable object.

Notes

If you do not specify the Environment, InstallCredential, NodeNamingSeries, Parameter, or WDSMode parameter, the Get-HpcClusterProperty gets all five types of cluster-wide properties.

Example 1

C:\PS>Get-HpcClusterProperty -Parameter -Name SpoolDir

Gets the value of a configuration parameter for the HPC cluster named SpoolDir.

Example 2

C:\PS>Get-HpcClusterProperty -Environment -Name:CCP_CLUSTER_NAME

Gets the value of an environment variable named CCP_CLUSTER_NAME.

Example 3

C:\PS>Get-HpcClusterProperty -NodeNamingSeries

Gets the naming series used to generate names for new compute nodes that you add to the HPC cluster.

Example 4

C:\PS>Get-HpcClusterProperty -InstallCredential

Gets the credentials used to install new compute nodes and run diagnostic tests.

See Also