Export (0) Print
Expand All
Expand Minimize

Remove-HpcJobCredential

Updated: January 10, 2014

Remove-HpcJobCredential

Deletes the cached credentials for one or more specified users that the job scheduler uses to submit jobs.

Syntax

Parameter Set: Default
Remove-HpcJobCredential [[-UserName] <String[]> ] [-Scheduler <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>


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 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

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

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, but can only delete credentials that the job scheduler users to submit jobs.

  • 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.

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 the job scheduler uses to submit jobs.


PS C:\>Remove-HpcJobCredential -UserName CONTOSO\someone

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft