Remove-HpcSoaSessionTrace

Remove-HpcSoaSessionTrace

This cmdlet is deprecated and was removed in HPC Pack 2012. Removes the Windows Communication Foundation (WCF) log files that contain the traces for the specified service-oriented architecture (SOA) session from the compute nodes.

Syntax

Parameter Set: id
Remove-HpcSoaSessionTrace [-Id] <Int32> [-Scheduler <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: job
Remove-HpcSoaSessionTrace -Job <HpcJob> [-Scheduler <String> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

Removes the WCF log files that contain the traces for the specified SOA session from the compute nodes. You can specify the SOA session by specifying the identifier for the SOA session or by specifying the HpcJob object for the service job for the session. This cmdlet performs the same action that occurs when you click Delete Trace in the Job Management view in HPC Cluster Manager.

Parameters

-Id<Int32>

Specifies the identifier of the SOA session for which you want to remove the log files. In HPC Pack 2008 R2, this session identifier was changed to the job identifier of the service job for the session. You cannot specify both the Id and Job parameters.

Aliases

none

Required?

true

Position?

1

Default Value

no default

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Job<HpcJob>

Specifies the service job for the SOA session for which you want to remove the log files. Use the Get-HpcJob cmdlet to get the HpcJob object for the service job. You cannot specify both the Id and Job parameters.

Aliases

none

Required?

true

Position?

named

Default Value

no default

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Scheduler<String>

Specifies the host name or IP address of the head node of the HPC cluster that ran the SOA session for which you want to remove the log files. 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

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

  • An HpcJob object

Outputs

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

  • None

Notes

  • The WCF log files for a session get created only if the event logging level for the SOA service is set to a value other than Off when the session starts. To set the event logging level for a SOA service in the Configuration view in HPC Cluster Manager, click Services in the navigation pane, click the name of the service, and then click Set Event Logging Level.

  • This cmdlet removes the WCF log files in the %CCP_DATA%\SoaTrace folder on each node. It does not remove copies of the WCF log files that were saved to other locations by running the Export-HpcSoaSessionTrace cmdlet or by clicking Collect Trace in the Job Management view of HPC Cluster Manager.

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

  • You must be a cluster administrator to run this cmdlet successfully.

  • This cmdlet is supported only for HPC Pack 2008 R2. It is deprecated and was removed in HPC Pack 2012.

Examples

EXAMPLE 1

Removes the WCF log files for the SOA session with a session identifier of 6.

PS C:\>Remove-HpcSoaSessionTrace –Id 6

EXAMPLE 2

Gets an HpcJob object for the job with a job identifier of 15, then removes the WCF log files for the SOA session for which that job was the service job by specifying the HpcJob object in the Job parameter of the Remove-HpcSoaSessionTrace cmdlet. The Remove-HpcSoaSessionTrace cmdlet prompts you for confirmation before removing the files.

PS C:\>$job = Get-HpcJob –Id 15 Remove-HpcSoaSessionTrace –Job $job –Confirm

EXAMPLE 3

Gets HpcJob objects for the jobs with a state of Finished, then lists the jobs for which the Remove-HpcSoaSessionTrace cmdlet would remove the WCF log files if you ran the example without including the WhatIf parameter in the Remove-HpcSoaSessionTrace cmdlet.

PS C:\>Get-HpcJob –State Finished | Remove-HpcSoaSessionTrace –Job -WhatIf

Export-HpcSoaSessionTrace

Get-HpcJob