Remove-HpcSoaCredential

Remove-HpcSoaCredential

Deletes the cached credentials for users that SOA clients use to create SOA sessions.

Syntax

Parameter Set: Default
Remove-HpcSoaCredential [[-UserName] <String[]> ] [-Azure] [-ClusterConnectionString <String[]> ] [-Scheduler <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]




Detailed Description

The Remove-HpcSoaCredential cmdlet deletes the cached credentials for one or more specified users that service-oriented architecture (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

-Azure

Indicates that the Scheduler parameter is the URL of an Azure cloud service that is running the Azure HPC Scheduler.

This parameter was introduced in HPC Pack 2008 R2 with Service Pack 3. It is not available in previous versions.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ClusterConnectionString<String[]>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-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

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-UserName<String[]>

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


Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. 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 was introduced in HPC Pack 2008 R2. It is not supported in previous versions.

Examples

Example 1: Remove cached credentials for a user

This command deletes the credentials for the user with a user name of pfuller and a domain of CONTOSO from the cached credentials that are used to create SOA sessions.


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

Related topics

Community Additions

ADD
Show: