Remove-HpcMember

Removes one or more specified members from the HPC cluster or from the specified roles.

Syntax

	Copy Code
Parameter Set: Default Remove-HpcMember [-Name] <String[]> [-Role <String[]> ] [-Scheduler <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Copy Code

Parameter Set: Default


Remove-HpcMember [-Name] <String[]> [-Role <String[]> ] [-Scheduler <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

Removes one or more specified members from the HPC cluster or from the specified roles. The roles in an HPC cluster are user and administrator.

Parameters

-Name<String[]>

Specifies a list of one or more names for the users or administrators 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 user or administrator.

Aliases	none
Required?	true
Position?	1
Default Value	no default
Accept Pipeline Input?	true (ByValue, ByPropertyName)
Accept Wildcard Characters?	true

-Role<String[]>

Specifies a list of one or more roles from which you want to remove the member. The valid roles are user and administrator.

Aliases	none
Required?	false
Position?	named
Default Value	user,administrator
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	%CCP_SCHEDULER%
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-Confirm

Prompts you for confirmation before executing the command.

Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

Describes what would happen if you executed the command without actually executing the command.

Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

<CommonParameters>

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

Inputs

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

One or more HpcMember objects, through their Name and Role properties.

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.

Examples

EXAMPLE 1

Removes the user or administrator with a user name of someone in the CONTOSO domain from the HPC cluster. If CONTOSO\someone belonged to both the user and administrator roles, the Remove-HpcMember cmdlet removes CONTOSO\someone from both roles.

	Copy Code
Remove-HpcMember -Name CONTOSO\someone

EXAMPLE 2

Removes the account with a user name of someone in the CONTOSO domain from the administrator role for the HPC cluster. If CONTOSO\someone also belonged to the user role, then CONTOSO\someone remains a member of the HPC cluster in that role.

	Copy Code
Remove-HpcMember -Name CONTOSO\someone -Role Administrator

EXAMPLE 3

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 belonged to both the user and administrator roles, the Remove-HpcMember cmdlet removes that account from both roles.

	Copy Code
Remove-HpcMember -Name CONTOSO\user1,CONTOSO\user2

EXAMPLE 4

Gets the HpcMember object or objects for the member with a user name of someone in the CONTOSO domain, 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.

	Copy Code
Get-HpcMember -Name CONTOSO\someone \| Remove-HpcMember

EXAMPLE 5

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

	Copy Code
Get-HpcMember -Role user \| Remove-HpcMember