Get-HpcClusterProperty
Get-HpcClusterProperty
Gets the cluster-wide properties for the specified HPC cluster.
Syntax
Parameter Set: default
Get-HpcClusterProperty [-Scheduler <String> ] [ <CommonParameters>]
Parameter Set: emailCredential
Get-HpcClusterProperty [-EmailCredential] [-Scheduler <String> ] [ <CommonParameters>]
Parameter Set: environment
Get-HpcClusterProperty [[-Name] <String> ] [-Environment] [-Scheduler <String> ] [ <CommonParameters>]
Parameter Set: installCredential
Get-HpcClusterProperty [-InstallCredential] [-Scheduler <String> ] [ <CommonParameters>]
Parameter Set: nodeNameSeries
Get-HpcClusterProperty [-NodeNamingSeries] [-Scheduler <String> ] [ <CommonParameters>]
Parameter Set: parameter
Get-HpcClusterProperty [[-Name] <String> ] [-Parameter] [-Scheduler <String> ] [ <CommonParameters>]
Parameter Set: restoreMode
Get-HpcClusterProperty [-RestoreMode] [-Scheduler <String> ] [ <CommonParameters>]
Parameter Set: wdsMode
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, credentials to use for sending email notifications, the naming series for new compute nodes, and the Windows Deployment Services mode. If you do not specify any parameters, this cmdlet get the values for all of these items.
Parameters
-EmailCredential
Gets the user account that the HPC cluster uses to send email notifications, if the email server requires credentials. The account must have administrative permissions on the head node.
You cannot specify the EmailCredential parameter with any of the following parameters: Environment, InstallCredential, NodeNamingSeries, Parameter, and WDSMode.
This parameter was introduced in HPC Pack 2008 R2. It is not supported in previous versions.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
not applicable |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-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, CCP_SERVICEREGISTRATION_PATH, 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 CCP_SERVICEREGISTRATION_PATH environment variable specifies the location where the configuration files for the service-oriented architecture (SOA) services should be placed to register the services, and is \\%CCP_CLUSTER_NAME%\HpcServiceRegistration by default. 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 the Environment parameter with any of the following parameters: InstallCredential, EmailCredential, NodeNamingSeries, Parameter, and WDSMode.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
not applicable |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InstallCredential
Gets the credentials that are used for installing new compute nodes and for running diagnostic tests.
You cannot specify the InstallCredential parameter with any of the following parameters: EmailCredential, Environment, NodeNamingSeries, Parameter, and WDSMode.
Aliases |
none |
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 the Environment or the Parameter parameter when you specify the Name parameter.
You cannot specify the Name parameter with any of the following parameters: InstallCredential, EmailCredential, NodeNamingSeries, and WDSMode.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
no default |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-NodeNamingSeries
Gets the naming series that is 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, EmailCredential, Parameter, and WDSMode.
Aliases |
none |
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 a specific configuration parameter for an HPC cluster, see the description of the parameter for the Set-HpcClusterProperty cmdlet that has the same name as the configuration parameter.
You cannot specify the Parameter parameter with any of the following parameters: Environment, InstallCredential, EmailCredential, NodeNamingSeries, and WDSMode.
Aliases |
none |
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>
Aliases |
none |
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, and the value is IgnoreUnknown if the head node responds only to requests from existing compute nodes.
You cannot specify the WDSMode parameter with any of the following parameters: Environment, InstallCredential, EmailCredential, NodeNamingSeries, and Parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
not applicable |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RestoreMode
Determines if the HPC Job Scheduler Service is in restore mode.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
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
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- None
Outputs
The output type is the type of the objects that the cmdlet emits.
- An HpcVariable object.
Notes
If you do not specify the Environment, InstallCredential, EmailCredential, NodeNamingSeries, Parameter, or WDSMode parameter, the Get-HpcClusterProperty gets all six types of cluster-wide properties.
You must be a cluster administrator to run this cmdlet successfully.
Examples
EXAMPLE 1
Gets the value of a configuration parameter for the HPC cluster named SpoolDir.
PS C:\>Get-HpcClusterProperty -Parameter -Name SpoolDir
EXAMPLE 2
Gets the value of an environment variable named CCP_CLUSTER_NAME.
PS C:\>Get-HpcClusterProperty -Environment -Name:CCP_CLUSTER_NAME
EXAMPLE 3
Gets the naming series that is used to generate names for new compute nodes that you add to the HPC cluster.
PS C:\>Get-HpcClusterProperty -NodeNamingSeries
EXAMPLE 4
Gets the credentials that are used to install new compute nodes and run diagnostic tests.
PS C:\>Get-HpcClusterProperty -InstallCredential
EXAMPLE 5
Gets the credentials that are used when sending email notifications.
PS C:\>Get-HpcClusterProperty -EmailCredential