Remove-HpcJobCredential
Deletes the cached credentials for one or more specified users that the job scheduler uses to submit jobs.
Syntax
Remove-HpcJobCredential [-Scheduler <string>] [-UserName <string[]>] [-confirm] [-whatif] [<CommonParameters>]
Detailed Description
Deletes the cached credentials for one or more specified users that the job scheduler uses to submit jobs. If you do not specify a user name, the cmdlet deletes the credential of the user who ran the cmdlet.
Parameters
-Scheduler <string>
Specifies the host name or IP address of the head node for the cluster for which the specified user can submit jobs. 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 |
-UserName <string[]>
Specifies the name of the user for whom you want to delete the cached credential.
|
Required? |
false |
|
Position? |
named |
|
Default Value |
the user name for the current user |
|
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 |
None. |
|
Return Type |
None. |
Notes
You cannot delete installation credentials, but can only delete credentials that the job scheduler users to submit jobs.
Example 1
C:\PS>Remove-HpcJobCredential -UserName CONTOSO\someone
Deletes the credentials for the user with a user name of someone and a domain of CONTOSO from the cached credentials that the job scheduler uses to submit jobs.