Citrix ADC (NetScaler) SOAP Body Capture Configuration

Overview

This documentation describes the configuration for Citrix ADC (NetScaler) to perform SOAP body capture for the s2r platform (source: deploy/lb-connectors/citrix/README.md). This component enables the Citrix ADC to extract and forward SOAP body envelopes from incoming POST requests to a designated relay virtual machine.

It is important to note that this Citrix ADC configuration is currently designated as "Documentation-only in v1" and is not actively maintained within the s2r product's core repository (source: deploy/lb-connectors/citrix/README.md). Operators are expected to adapt the provided configuration snippets from the relevant RFC to their specific environment (source: deploy/lb-connectors/citrix/README.md).

How it Works

The Citrix ADC SOAP body capture mechanism involves two primary components: a NITRO HTTP callout and a rewrite policy (source: deploy/lb-connectors/citrix/README.md).

1. NITRO HTTP Callout Definition: A NITRO callout, specifically add policy httpCallout s2r_body_capture, is defined. This callout is configured to POST the BB #12 envelope to a relay VM (source: deploy/lb-connectors/citrix/README.md).
2. Rewrite Policy Definition: A rewrite policy, add rewrite policy pol_s2r_body_capture, is defined. This policy is responsible for triggering the s2r_body_capture callout when it encounters POST requests (source: deploy/lb-connectors/citrix/README.md).
3. Policy Binding: The pol_s2r_body_capture rewrite policy must be bound to the relevant load balancer virtual servers (bind lb vserver <vserver-name>) to become active (source: deploy/lb-connectors/citrix/README.md).
4. Header Injection (Optional): An additional mechanism for header injection is described, which uses a Rewrite Policy with an ADD action on HTTP.REQ.HEADER("X-Client-IP") bound to the REQUEST flow (source: deploy/lb-connectors/citrix/README.md).

Configuration Elements

The full Citrix ADC body-capture configuration is detailed in docs/rfc/lb-syslog-discovery.md §2.1 — "Citrix ADC (NetScaler) body-capture" (source: deploy/lb-connectors/citrix/README.md). The source identifies the following key configuration elements:

| Element Name | Description | | add policy httpCallout s2r_body_capture | Defines a NITRO callout that posts the BB #12 envelope to the relay VM. (source: deploy/lb-connectors/citrix/README.md) | | add rewrite policy pol_s2r_body_capture | Defines a rewrite policy that triggers the s2r_body_capture callout on POST requests. (source: deploy/lb-connectout/citrix/README.md) | | add rewrite policy s2r_body_capture | A specific type of add rewrite policy that triggers the callout on POST requests. (source: `deploy/lb-connectors/citrix/README.

---

All SOAP-to-REST docs