3 Tracing

3.1 Get-anynodeTracing

Returns the current tracing options.

Required Permissions

  • API

  • Tracing

Request parameters

  • Address

    mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.

    Type: String

  • Port

    mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.

    Type: Integer

  • APIVersion = 0

    This parameter states which version of the request should be used.

    Type: Integer

  • string: Product

    Choose for which product the current tracing options should be requested for. If this parameter is not given, the current options for anynode are requested.

    Type: String

    Possible Values:

    • anynode

    • anynodeFrontend

    • anynodeMonitor

    • anynodeAdministration

Return Value Structure

The response body is structured as TracingOptionsJson JSON object. A description for its fields is at section 29.2.1. For the JSON schema refer to section 29.2.2.

3.2 Set-anynodeTracing

Sets the tracing options.

Required Permissions

  • API

  • Tracing

Request parameters

  • Address

    mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.

    Type: String

  • Port

    mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.

    Type: Integer

  • APIVersion = 0

    This parameter states which version of the request should be used.

    Type: Integer

  • string: Product

    Choose for which product the current tracing options should be requested for. If this parameter is not given, the current options for anynode are requested.

    Type: String

    Possible Values:

    • anynode

    • anynodeFrontend

    • anynodeMonitor

    • anynodeAdministration

  • Selection

    Selects how tracing records will be stored.

    Type: TracingSelection

    Possible values:

    • FILE

      Single file, no size limit.

    • SPLIT

      Rolling files of limited size.

  • TraceActive

    Type: Boolean

  • Options

    Type: TracingFileOptions

Return Value Structure

The response body is structured as TracingOptionsJson JSON object. A description for its fields is at section 29.2.1. For the JSON schema refer to section 29.2.2.

3.3 Get-anynodeTrace

Returns the trace file(s).

Required Permissions

  • API

  • Tracing

Request parameters

  • Address

    mandatory if Initialize-anynodeAddress has not been used. Location of the frontend service to be reached.

    Type: String

  • Port

    mandatory if Initialize-anynodePort has not been used. Port of the frontend service to be reached.

    Type: Integer

  • APIVersion = 0

    This parameter states which version of the request should be used.

    Type: Integer

  • string: Product

    Choose for which product the current trace files should be requested for. If this parameter is not given, the current trace from anynode will be returned.

    Type: String

    Possible Values:

    • anynode

    • anynodeFrontend

    • anynodeMonitor

    • anynodeAdministration