Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Payload Capture page shows Active WS-M subscriptions, active payload captures and allows the user to stop active subscriptions captures and create new subscriptionscaptures.

This

...

page only shows and manages

...

captures that were created by DPOD.

View or Stop Active

...

Payload Captures

The Payload Capture page shows a list of currently active WS-M subscriptionpayload captures:

Column

Description

Device

The device

where the WS-M subscription was started

(s) in which payload is captured.

Domain

The domain

where the WS-M subscription was started

(s) in which payload is captured.

Catalog (API Connect product view only)

For DataPower API Gateway - the catalog in which payload is captured.

For DataPower Gateway - the field will be empty, the capture is for all the transactions in the device/domain.

User Name

The user name who created the

subscription

capture.

Start Time

When the

subscription was

capture started.

End Time

When the

subscription

capture will end

(the subscription will end automatically)

Subscription Id (Context Id)

The DataPower Id of the subscription

Stop Subscription

Stop the subscription

.

Context ID

The DataPower context ID for this capture. For DataPower API Gateway - this is an internal DPOD ID.

Stop Capture

Stop the capture.
Every user that has access to the page (and has permission to view the device/domain) may stop a

subscription

capture, even if it was created by another user or by an admin.

Create

...

Capture

Click the "Create SubscriptionNew Capture" button (on the top-right) to create a new capture.

API-Connect DataPower API Gateway Payload Capture

Note

It is recommended to use API-Connect Analytics Offload for payload capturing if possible. If an Analytics Endpoint already exists, the payload capture should be done using Analytics Offload only, otherwise it will be overridden.

API-Connect Analytics Endpoint is used for payload and headers capturing of transactions across all APIs in the specified device, domain and catalog, which are configured to log payload/headers in their assembly.

You may choose multiple devices, domains, and catalogs, or use an asterisk as a wildcard. For example, choosing QA* for the device name and DMZ for the domain name, will record payloads for all DMZ domains in devices QA1, QA2 and QA3.

DataPower API Gateway Payload Subscriptions are not limited by time. However, the capture will stop after an API is deployed or redeployed to the catalog or after a catalog property has changed.

API-Connect v5/v5-c DataPower Gateway Payload Capture

Enter the device, domain, and duration in minutes (up to the maximum duration defined by the system administrator), to create a WS-M subscription childrenfor payload capturing of transactions across all APIs in the specified device and domain.

You may choose multiple devices and domains, or use an asterisk as a wildcard. For example, choosing QA* for the device name and DMZ for the domain name, will record payloads for all DMZ domains in devices QA1, QA2 and QA3.

DataPower Transactions Payload Capture

Enter the device, domain, and duration in minutes (up to the maximum duration defined by the system administrator), to create a WS-M subscription for payload capturing of transactions across all services in the specified device and domain.

You may choose multiple devices and domains, or use an asterisk as a wildcard. For example, choosing QA* for the device name and DMZ for the domain name, will record payloads for all DMZ domains in devices QA1, QA2 and QA3.