Set-HpcSoaCredential

Set-HpcSoaCredential

Sets the credentials for creating SOA sessions.

Syntax

Parameter Set: Default
Set-HpcSoaCredential -Credential <PSCredential> [-Azure] [-ClusterConnectionString <String[]> ] [-Scheduler <String[]> ] [ <CommonParameters>]




Detailed Description

The Set-HpcSoaCredential cmdlet sets the credentials for creating service-oriented architecture (SOA) sessions. The cmdlet stores these credentials in the credential cache of the user who ran the cmdlet.

Parameters

-Azure

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

This parameter was introduced in HPC Pack 2008 R2 with Service Pack 3 (SP3). 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

-Credential<PSCredential>

Specifies a PSCredential object that represents the credentials that you want to set for creating SOA sessions on the cluster that the Scheduler parameters specifies. This cmdlet sets these credentials in the credential cache of the user who ran the cmdlet.

You can use the Get-Credential cmdlet to get a PsCredential object. Save that object in a variable, and then use that variable with this parameter.


Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Scheduler<String[]>

Specifies the host name or the IP address of the head node for the cluster for which you want to set the credentials that are used to create the 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

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

  • PsCredential

Outputs

The output type is the type of the objects that the cmdlet emits.

  • None

Notes

  • The cached credentials are used to create SOA sessions when the SOA client application does not specify a user name and password in the SessionStartInfo object that the application specifies when creating the session.

  • This cmdlet was introduced in HPC Pack 2008 R2. It is not supported in previous versions.

Examples

Example 1: Set SOA session credentials

This command sets the credentials for creating SOA sessions on the cluster. When the Set-HpcSoaCredential cmdlet runs, a dialog box appears that requests a user name and password. After you enter this information, the Set-HpcSoaCredential cmdlet sets the credentials for creating SOA sessions on the cluster to the credentials that you supplied.


PS C:\> Set-HpcSoaCredential

Example 2: Get a credential and use it to update SOA credentials

This command gets a PSCredential object, and then sets the credentials for creating SOA sessions on the cluster to the credentials that the PSCredential object represents. When the Get-Credential cmdlet runs, a dialog box appears that requests a user name and password. After you enter this information, the Get-Credential cmdlet creates the PSCredential object and passes it to the Set-HpcSoaCredential cmdlet.


PS C:\> $Credential = Get-Credential
Set-HpcSoaCredential -Credential $Credential

Related topics

Community Additions

ADD
Show: