Remove-HpcMember

Remove-HpcMember

Removes members from the HPC cluster or from specified roles.

Syntax

Parameter Set: Default
Remove-HpcMember [-Name] <String[]> [-ClusterConnectionString <String[]> ] [-Role {user | administrator | jobadministrator | joboperator}[] ] [-Scheduler <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Remove-HpcMember cmdlet removes one or more specified members from the HPC cluster or from the specified roles. If you do not specify a role, the members are removed from all roles to which they belong.

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String[]>

Specifies an array of names for the members that you want to remove from the HPC cluster, or from the role that the Role parameter specifies. Use the domain\user_name format to specify a member.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue, ByPropertyName)

Accept Wildcard Characters?

false

-Role<String[]>

Specifies an array of roles from which you want to remove the members. Valid values are: User, Administrator.

The following additional roles were introduced in HPC Pack 2012 with Service Pack 1 (SP1): JobAdministrator and JobOperator. These roles are not supported in previous versions.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Scheduler<String[]>

Specifies the host name or IP address of the head node for the cluster that includes the members. 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

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.


Required?

false

Position?

named

Default Value

false

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.

  • HpcMember[]

Outputs

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

  • None

Notes

  • The built-in ConfirmImpact setting for this cmdlet is Medium. If this ConfirmImpact setting is equal to or higher than the value of the $ConfirmPreference variable for your environment, the cmdlet prompts for confirmation unless you specify –Confirm:$False. If this ConfirmImpact setting is lower than the value of the $ConfirmPreference variable for your environment, the cmdlet does not prompt for confirmation unless you specify –Confirm or –Confirm:$True.

  • You must be a cluster administrator to run this cmdlet successfully.

  • For information about user roles on the HPC cluster, see Understanding User Roles (http://technet.microsoft.com/library/ff919445(v=ws.10).aspx) in the TechNet library.

Examples

Example 1: Remove a member by name

This command removes the user or administrator with a user name of PattiFuller in the CONTOSO domain from the HPC cluster. If CONTOSO\PattiFuller belongs to both the user and administrator roles, the Remove-HpcMember cmdlet removes CONTOSO\PattiFuller from both roles.


PS C:\> Remove-HpcMember -Name "CONTOSO\PattiFuller"

Example 2: Remove a member from a role

This command removes the account with a user name of PattiFuller in the CONTOSO domain from the administrator role for the HPC cluster. If CONTOSO\PattiFuller also belongs to the user role, then CONTOSO\PattiFuller remains a member of the HPC cluster in that role.


PS C:\> Remove-HpcMember -Name "CONTOSO\PattiFuller" -Role "Administrator"

Example 3: Remove multiple members

This command removes the users or administrators with user names of user1 and user2 in the CONTOSO domain from the HPC cluster. If CONTOSO\user1 or CONTOSO\user2 belongs to both the user and administrator roles, the Remove-HpcMember cmdlet removes that account from both roles.


PS C:\> Remove-HpcMember -Name "CONTOSO\user1,CONTOSO\user2"

Example 4: Get a member by name and remove it

Gets the HpcMember object or objects for the member with a user name of someone in the CONTOSO domain, and then removes that member from all roles to which the member belongs and from the HPC cluster by redirecting the Name property of the HpcMember object or objects to the Remove-HpcMember cmdlet.


PS C:\> Get-HpcMember -Name "CONTOSO\PattiFuller" | Remove-HpcMember

Example 5: Get members by role and remove them

This command gets the HpcMember objects for all the members of the user role for the HPC cluster, and then removes those members from the user role by redirecting the Name and Roles properties of the HpcMember objects to the Remove-HpcMember cmdlet.


PS C:\> Get-HpcMember -Role "User" | Remove-HpcMember

Related topics

Community Additions

ADD
Show: