Remove-HpcSoaCredential
Syntax
![]() |
|
---|---|
Parameter Set: Default Remove-HpcSoaCredential [[-UserName] <String[]> ] [-Scheduler <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>] |
Detailed Description
Deletes the cached credentials for one or more specified users that SOA clients use to create SOA sessions. 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 create SOA sessions. 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 |
-UserName<String[]>
Specifies the name of the user for whom you want to delete the cached credential.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
the user name of 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
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- None
Outputs
The output type is the type of the objects that the cmdlet emits.
- None
Notes
-
You cannot delete installation credentials, and you can only delete credentials for creating SOA sessions, submitting jobs, or running diagnostic tests.
-
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.
-
This cmdlet is supported only for Windows HPC Server 2008 R2.
Examples
EXAMPLE 1
Deletes the credentials for the user with a user name of Someone and a domain of CONTOSO from the cached credentials that are used to create SOA sessions.
![]() |
|
---|---|
Remove-HpcSOACredential -UserName CONTOSO\someone |