Remove-HpcJobCredential

  • Reference
Module:
HPCPack2016

Deletes cached credentials that the job scheduler uses to submit jobs.

Syntax

Remove-HpcJobCredential
      [[-UserName] <String[]>]
      [-ClusterConnectionString <String[]>]
      [-Scheduler <String[]>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-HpcJobCredential cmdlet 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.

Examples

Example 1: Remove credentials for a user

PS C:\>Remove-HpcJobCredential -UserName "CONTOSO\pfuller"

This command deletes the credentials for the user with a user name of pfuller and a domain of CONTOSO from the cached credentials that the job scheduler uses to submit jobs.

Parameters

-ClusterConnectionString

Specifies an array of cluster connection strings for the cluster to which you want to add the device drivers. The value format is host1,host2,host3. If you do not specify the ClusterConnectionString parameter, this cmdlet uses the connection string on the head node that the CCP_CONNECTIONSTRING environment variable specifies. To set this environment variable, run the following cmdlet: Set-Content Env: CCP_CONNECTIONSTRING \<head_node_name\>.

This parameter was introduced in HPC Pack 2016.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Scheduler

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

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-UserName

Specifies an array of names of users for whom you want to delete cached credentials.

Type:String[]
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

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.