Get-HpcClusterRegistry

  • Reference
Module:
HPCPack2016

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

Syntax

Get-HpcClusterRegistry
   [-PropertyName <String>]
   [-ClusterConnectionString <String[]>]
   [-Scheduler <String[]>]
   [<CommonParameters>]

Description

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

Examples

Example 1: Get all properties

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

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

Example 2: Get the value of a configuration property

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

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

Parameters

-ClusterConnectionString

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.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PropertyName

Specifies the property name that this cmdlet gets.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Scheduler

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\>.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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.