Export (0) Print
Expand All

Remove-HpcMember

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

Syntax

Remove-HpcMember [-Role <string[]>] [-Scheduler <string>] [-Name] <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.

 

Required?

true

Position?

1

Default Value

no default

Accept Pipeline Input?

true (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.

 

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>

 

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.

Input and Return Types

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

 

Input Type

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

Return Type

None.

Example 1

C:\PS>Remove-HpcMember -Name CONTOSO\someone

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.

Example 2

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

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.

Example 3

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

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.

Example 4

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

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.

Example 5

C:\PS>Get-HpcMember -Role user | Remove-HpcMember

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.

See Also

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft