Get-HpcClusterRegistry

Windows Server 2016 and Windows 10

Get-HpcClusterRegistry

Gets configuration properties related to HPC Pack which are stored in the Service Fabric property store.

Syntax

Parameter Set: Default
Get-HpcClusterRegistry [-ClusterConnectionString <String[]> ] [-PropertyName <String> ] [-Scheduler <String[]> ] [ <CommonParameters>]




Detailed Description

The Get-HpcClusterRegistry cmdlet gets configuration properties related to HPC Pack which are stored in the Service Fabric property store.

Parameters

-ClusterConnectionString<String[]>

Specifies an array of cluster connection strings for the cluster to which you want to add the device drivers. The value format is host1,host2,host3. If you do not specify the ClusterConnectionString parameter, this cmdlet uses the connection string on the head node that the CCP_CONNECTIONSTRING environment variable specifies. To set this environment variable, run the following cmdlet: Set-Content Env: CCP_CONNECTIONSTRING <head_node_name>.

This parameter was added in HPC 2016.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PropertyName<String>

Specifies the property name that this cmdlet gets.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Scheduler<String[]>

Specifies an array of host names or IP addresses of the head node for the cluster to which you add the node. 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

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

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

Inputs

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

Outputs

The output type is the type of the objects that the cmdlet emits.

Notes

  • This cmdlet was introduced in HPC Pack 2016.

    In versions of HPC Pack before HPC Pack 2016, the configurations are stored in a registry key on the head node.

Examples

Example 1: Get all properties

This command gets all properties for cluster hosts named host01, host02, and host03.


PS C:\> Get-HpcClusterProperty -ClusterConnectionString "host01, host02,host03"

Example 2: Get the value of a configuration property

This command gets the value of the configuration property named ClusterName.


PS C:\> Get-HpcClusterRegistry -PropertyName "ClusterName"

Related topics

Community Additions

ADD
Show: