Export-HpcSoaSessionTrace

Export-HpcSoaSessionTrace

This cmdlet is deprecated and was removed in Microsoft® HPC Pack 2012. Copies the Windows Communication Foundation (WCF) log files that contain the traces for the specified service-oriented architecture (SOA) session from each of the compute nodes to a single location so that you can view the log files with Service Trace Viewer.

Syntax

Parameter Set: id
Export-HpcSoaSessionTrace [-Id] <Int32> -Path <String> [-Scheduler <String> ] [ <CommonParameters>]

Parameter Set: job
Export-HpcSoaSessionTrace -Job <HpcJob> -Path <String> [-Scheduler <String> ] [ <CommonParameters>]

Detailed Description

Copies the WCF log files that contain the traces for the specified SOA session from each of the compute nodes to a single location so that you can view the log file with Service Trace Viewer. 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 Collect 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 collect the log files. In HPC Pack 2008 R2, this session identifier is 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 collect 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

-Path<String>

Specifies the location where you want the log files to be collected. This location should be a shared folder that is accessible from all of the compute nodes; for example, \\%CCP_SCHEDULER%\CcpSpoolDir.

Aliases

none

Required?

true

Position?

named

Default Value

no default

Accept Pipeline Input?

false

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

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

  • The WCF log files are originally saved in the %CCP_DATA%\SoaTrace folder on each node. The log files have names of [job_id]_[task_id].[subtask_id]_trace.svclog, where there is a different subtask for each node. This cmdlet copies all of these files to a shared folder on a single node.

  • The WCF log files can take up a lot of disk space, so you should remove them periodically by running the Remove-HpcSoaSessionTrace cmdlet.

  • 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

Copies the WCF log files from the SOA session with a session identifier of 3 from the compute nodes to the shared folder at \\HeadNode\CcpSpoolDir.

PS C:\>Export-HpcSoaSessionTrace –Id 3 –Path \\HeadNode\CcpSpoolDir

EXAMPLE 2

Gets the HpcJob object for the job with a job identifier of 6, and copies the WCF log files from the SOA session for which that job is the service job from the compute nodes to the shared folder at \\HeadNode\CcpSpoolDir.

PS C:\>Get-HpcJob –Id 6 | Export-HpcSoaSessionTrace –Path \\HeadNode\CcpSpoolDir

EXAMPLE 3

Gets the HpcJob object for the job with a job identifier of 8 and saves that object in a variable. The example then uses that variable with the Job parameter of the Export-HpcSoaSessionTrace cmdlet to copy the WCF log files from the SOA session for which that job is the service job from the compute nodes to the shared folder at \\HeadNode\CcpSpoolDir.

PS C:\>$job = Get-HpcJob –Id 8

Export-HpcSoaSessionTrace –Job $job –Path \\HeadNode\CcpSpoolDir

Get-HpcJob

Remove-HpcSoaSessionTrace