Set-HpcClusterRegistry

Windows Server 2016 and Windows 10

Set-HpcClusterRegistry

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

Syntax

Parameter Set: AAD
Set-HpcClusterRegistry [-AADAppName <String> ] [-AADClientAppId <String> ] [-AADClientAppRedirectUri <String> ] [-AADInstance <String> ] [-AADTenant <String> ] [-ClusterConnectionString <String[]> ] [-Scheduler <String[]> ] [-SupportAAD <String> ] [ <CommonParameters>]

Parameter Set: General
Set-HpcClusterRegistry -PropertyName <String> -PropertyValue <Object> [-ClusterConnectionString <String[]> ] [-Scheduler <String[]> ] [ <CommonParameters>]




Detailed Description

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

Parameters

-AADAppName<String>

Specifies the name of the application in Azure Active Directory.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AADClientAppId<String>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AADClientAppRedirectUri<String>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AADInstance<String>

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-AADTenant<String>

Specifies the tenant ID of Azure Active Directory.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-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 introduced in HPC Pack 2016.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PropertyName<String>

Specifies the name of the property this cmdlet modifies.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PropertyValue<Object>

Specifies the value of the property this cmdlet modifies.


Aliases

none

Required?

true

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

-SupportAAD<String>

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


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: Set a configuration property

This command sets the Active Directory application name to App002.


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

Example 2: Set the installation credential

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


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

Related topics

Community Additions

ADD
Show: