Set-HpcClusterRegistry

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

Syntax

Set-HpcClusterRegistry
   -PropertyName <String>
   -PropertyValue <Object>
   [-ClusterConnectionString <String[]>]
   [-Scheduler <String[]>]
   [<CommonParameters>]
Set-HpcClusterRegistry
   [-SupportAAD <String>]
   [-AADInstance <String>]
   [-AADAppName <String>]
   [-AADTenant <String>]
   [-AADClientAppId <String>]
   [-AADClientAppRedirectUri <String>]
   [-ClusterConnectionString <String[]>]
   [-Scheduler <String[]>]
   [<CommonParameters>]

Description

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

Examples

Example 1: Set a configuration property

PS C:\>Set-HpcClusterRegistry -AADAppName "App002"

This command sets the Active Directory application name to App002.

Example 2: Set the installation credential

PS C:\>Set-HpcClusterRegistry -PropertyName "LinuxHttps" -PropertyValue "PropertyValue"

This command sets the installation credentials for the property named LinuxHttps using the property value named PropertyValue.

Required Parameters

-PropertyName

Specifies the name of the property this cmdlet modifies.

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

Specifies the value of the property this cmdlet modifies.

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

Optional Parameters

-AADAppName

Specifies the name of the application in Azure Active Directory.

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

Specifies the application ID of the client application in Azure Active Directory.

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

Specifies the redirect URI of the client application in Azure Active Directory

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

Specifies the base endpoint of Azure Active Directory. For global Azure, the value is https://login.microsoftonline.com/.

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

Specifies the tenant ID of Azure Active Directory.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-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 introduced in HPC Pack 2016.

Type:String[]
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
-SupportAAD

Specifies whether Azure Active Directory is supported for the HPC cluster. The value can be true or false.

Type:String
Position:Named
Default value:None
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.