Citrix ADC (NetScaler) SOAP Body Capture Configuration Overview

Overview of Citrix ADC (NetScaler) configuration for SOAP body capture, including NITRO HTTP callout and rewrite policy details.

Overview

This document provides an overview of the Citrix ADC (NetScaler) configuration for SOAP body capture (source: deploy/lb-connectors/citrix/README.md). This configuration is designed to capture the BB #12 envelope and POST it to a relay VM using a NITRO HTTP callout (source: deploy/lb-connectors/citrix/README.md).

For v1 of the platform, this specific Citrix ADC configuration is not actively maintained within this directory. Only HAProxy and nginx body-capture scripts are officially shipped and maintained. API consumers or operators intending to use Citrix ADC for this purpose should refer to the full configuration documented in the relevant RFC and adapt it to their environment (source: deploy/lb-connectors/citrix/README.md).

How it Works

The Citrix ADC body-capture mechanism involves several key components, as detailed in the RFC (source: deploy/lb-connectors/citrix/README.md):

NITRO HTTP Callout Definition: A policy that defines the HTTP callout. This callout is responsible for POSTing the captured BB #12 envelope to the relay VM.
```
add policy httpCallout s2r_body_capture
```
(source: deploy/lb-connectors/citrix/README.md)
Rewrite Policy: A policy that triggers the defined NITRO HTTP callout. This policy is typically configured to activate on POST requests.
```
add rewrite policy pol_s2r_body_capture
```
(source: deploy/lb-connectors/citrix/README.md)
Virtual Server Binding: The rewrite policy must be bound to the relevant load balancing virtual servers (lb vserver) to apply the body capture logic.
```
bind lb vserver <vserver-name>
```
(source: deploy/lb-connectors/citrix/README.md)
Header Injection: The configuration also covers the equivalent of header injection, implemented via 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).

The full configuration, including these elements, is documented in docs/rfc/lb-syslog-discovery.md §2.1 — "Citrix ADC (NetScaler) body-capture" (source: deploy/lb-connectors/citrix/README.md).

Contributions

Contributions of a fully-tested Citrix ADC configuration are welcome. If an API consumer or operator has a tested configuration, they can contribute by opening a Pull Request (PR) that includes (source: deploy/lb-connectors/citrix/README.md):

A Citrix NITRO callout configuration file (in .conf or .sh format).
An updated version of the deploy/lb-connectors/citrix/README.md file, including installation steps.

For general contribution guidelines, refer to docs/lld/contribution-guidelines.md. Alternatively, an issue can be opened describing the environment and the tested configuration (source: deploy/lb-connectors/citrix/README.md).

Tagsoverview

All SOAP-to-REST docs