The passphrase is used to encrypt your .pcap files generated by Packet Capture. While the passphrase is required to download capture files, it is not required to view packet capture analysis of capture files through APM. Remember the passphrase. If you lose it you can reset it, but you cannot download any captures encrypted with the old passphrase.

Determine if a passphrase is configured

Web admin

  1. Log in to Web Admin.
  2. Navigate to Usage Monitoring Settings > Packet Capture.
    • If the DELETE PASSPHRASE button is enabled, a passphrase exists on the monitoring point. If it is disabled a passphrase does not exist.

Admin API

  1. Access the Admin API.
  2. Navigate to Capture Passphrase > GET /flow/passphrase/.
  3. Click Submit.
    • In the Response Body section, look for "success": true.
    • Also look for "capture_passphrase_configured": true to show that the passphrase is configured. It will show "capture_passphrase_configured": false if it is not.

Web admin

  1. Log in to Web Admin.
  2. Navigate to Appliance Configuration > Capture Passphrase Configuration.
    • If there is a passphrase configured, you will receive a warning message saying that a passphrase is already configured for the device.

Set the passphrase

Setting the passphrase is required in order to perform packet captures.

Web admin

  1. Log in to Web Admin.
  2. Navigate to Usage Monitoring Settings > Packet Capture.
  3. Enter a passphrase.
  4. Click Submit.
    • The passphrase is set for the monitoring point.

Admin API

  1. Access the Admin API.
  2. Navigate to Capture Passphrase > PUT /flow/passphrase/.
  3. In the Parameters section, paste the following in the body field (where <passphrase> is your chosen passphrase):

    {
      "passphrase": "<passphrase>"
    }
    
  4. Click Submit.
    • In the Response Body section, look for "success": true to confirm that the passphrase was successfully set.

Web admin

  1. Log in to Web Admin.
  2. Navigate to Appliance Configuration > Capture Passphrase Configuration.
  3. In the Passphrase field, enter your passphrase.
  4. In the Confirm Passphrase field, re-enter your passphrase.
  5. Click Set Passphrase.
    • The passphrase it set.
  6. Click OK.

Clear the passphrase

This function is included in device setup and decommission, so you will likely never need to use it explicitly.

Web admin

  1. Log in to Web Admin.
  2. Navigate to Usage Monitoring Settings > Packet Capture.
  3. Click DELETE PASSPHRASE.
  4. Click Continue.
    • The passphrase is deleted

Admin API

  1. Access the Admin API.
  2. Navigate to Capture Passphrase > DELETE /flow/passphrase/.
  3. Click Submit.
    • In the Response Body section, look for "success": true to confirm that the passphrase was successfully cleared.

Web admin

  1. Log in to Web Admin.
  2. Click Appliance Configuration.
  3. Click Clear Passphrase.
  4. Click OK.
    • The passphrase is cleared.