NetScaler

Installing the Citrix ADC web logging (NSWL) client

When you install NSWL, the client executable file (nswl) is installed along with other files. The nswl executable file provides a list of options that you can use. For details, see Configuring the NSWL Client.

Attention:

The version of the NSWL client must be the same as that of the Citrix ADC. For example, if the version of the Citrix ADC is 10.1 Build 125.9, the NSWL client must also be of the same version. Also, the web logging (NSWL) client works on both 32 bit and on 64 bit server machines.

The following table lists the operating systems on which the NSWL client can be installed.

Operating system Version Hardware requirements Remarks
Windows Windows Server 2016 or later Processor - x86/amd64 CPU (1GHz or higher), RAM - 4 GB (or higher)  
macOS macOS 8.6 or later Not supported on Citrix ADC 10.1 and later releases.  
Linux Ubuntu, SUSE Linux, CentOS, Red Hat Enterprise Linux released in 2016 or later Processor - x86/amd64 CPU (1GHz or higher), RAM - 4 GB (or higher)  
Solaris Solaris Sun OS 5.6 or later Processor - UltraSPARC-IIi 400 MHz, RAM - 512 MB, Controller - SCSI Not supported on Citrix ADC 10.5 and later releases.
FreeBSD FreeBSD 6.3 or later Processor - x86/amd64 CPU (1GHz or higher), RAM - 4 GB (or higher) For Citrix ADC 10.5, use only FreeBSD 8.4.
AIX AIX 6.1 - Not supported on Citrix ADC 10.5 and later releases.

If the NSWL client system cannot process the log transaction because of a CPU limitation, the Web log buffer overruns and the logging process reinitiates.

Caution: Reinitiation of logging can result in loss of log transactions.

To temporarily solve an NSWL client system bottleneck caused by a CPU limitation, you can tune the Web server logging buffer size on the Citrix ADC appliance. To solve the problem, you need a client system that can handle the site’s throughput.

Download NSWL client

You can obtain the NSWL client package from either the Citrix ADC product CD or the Citrix downloads site. Within the package there are separate installation packages for each supported platform.

To download the NSWL client from the Citrix website

  1. Log on to Citrix by accessing the URL https://www.citrix.com/downloads/citrix-adc/.
  2. Navigate to a particular Citrix ADC release version and look for its Firmware.
  3. Click Firmware (for example, Citrix ADC Release (Feature Phase) 13.0 Build 52.24).

    Firmware page

  4. In the Citrix ADC Release (Feature Phase) Build page, go to Weblog Clients section.
  5. The section allows you to download Weblog clients for Windows, Linux, and BSD.

    Weblog client download

Install NSWL client on Solaris

To install the NSWL client, perform the following operations on the system where you downloaded the package.

  1. Extract the nswl_solaris-<release number>-<build number>.tar file from the package.
  2. Copy the extracted file to a Solaris system on which you want to install the NSWL client.
  3. Extract the files from the tar file with the following command:

tar xvf nswl_solaris-9.3-51.5.tar

A directory NSweblog is created in the temporary directory, and the files are extracted to the NSweblog directory.

  1. Install the package with the following command:

pkgadd -d

The list of available packages appears. In the following example, one NSweblog package is shown:

1 NSweblog Citrix ADC Weblogging (SunOS,sparc) 7.0

  1. You are prompted to select the packages. Select the package number of the NSweblog to be installed.

After you select the package number and press Enter, the files are extracted and installed in the following directories:

  • /usr/local/netscaler/etc
  • /usr/local/netscaler/bin
  • /usr/local/netscaler/samples
  1. To check whether the NSWL package is installed, execute the following command:

pkginfo | grep NSweblog

Note: To uninstall the NSWL package, execute the following command:

pkgrm NSweblog

Install NSWL client on Linux

To install the NSWL client, perform the following operations on the system where you downloaded the package.

  1. Extract the nswl_linux-<release number>-<build number>.rpm file from the package.

  2. Copy the extracted file to a system, running Linux OS, on which you want to install the NSWL client.

  3. To install the NSWL package, execute the following command:

rpm -i nswl_linux-9.3-51.5.rpm

This command extracts the files and installs them in the following directories.

  • /usr/local/netscaler/etc
  • /usr/local/netscaler/bin
  • /usr/local/netscaler/samples

Note: To uninstall the NSWL package, execute the following command:

rpm -e NSweblog

Note: To get more information about the NSweblog RPM file, execute the following command:

rpm -qpi *.rpm

Note: To view the installed Web server logging files, execute the following command:

rpm -qpl *.rpm

Install NSWL client on FreeBSD

To install the NSWL client, perform the following operations on the system where you downloaded the package.

  1. Extract the nswl_bsd-<release number>-<build number>.tgz file from the package.

  2. Copy the extracted file to a system, running FreeBSD OS, on which you want to install the NSWL client.

  3. To install the NSWL package, execute the following command:

pkg_add nswl_bsd-9.3-51.5.tgz

This command extracts the files and installs them in the following directories.

-  /usr/local/netscaler/etc
-  /usr/local/netscaler/bin
-  /usr/local/netscaler/samples

Note: To uninstall the NSWL package, execute the following command:

pkg_delete NSweblog

  1. To verify that the package is installed, execute the following command:

pkg_info | grep NSweblog

Install the NSWL client on Mac

To install the NSWL client, perform the following operations on the system where you downloaded the package.

  1. Extract the nswl_macos-<release number>-<build number>.tgz file from the package.

  2. Copy the extracted file to a system, running macOS, on which you want to install the NSWL client.

  3. To install the NSWL package, execute the following command:

pkg_add nswl_macos-9.3-51.5.tgz

This command extracts the files and installs them in the following directories:

  • /usr/local/netscaler/etc
  • /usr/local/netscaler/bin
  • /usr/local/netscaler/samples

Note: To uninstall the NSWL package, execute the following command:

pkg_delete NSweblog

  1. To verify that the package is installed, execute the following command:

pkg_info | grep NSweblog

Install NSWL client on Windows

To install the NSWL client, perform the following operations on the system where you downloaded the package.

  1. Extract the nswl_win-<release number>-<build number>.zip file from the package.
  2. Copy the extracted file to a Windows system on which you want to install the NSWL client.
  3. On the Windows system, unzip the file in a directory (referred as <NSWL-HOME>). The following directories are extracted: /bin, and /etc, and /samples.
  4. At the command prompt, run the following command from the <NSWL-HOME>\bin directory:

nswl -install -f <directorypath>\log.conf

Where,

directory path refers to the path of the configuration file (log.conf). By default, the file is in the <NSWL-HOME> and /etc directory. However, you can copy the configuration file to any other directory.

Note: To uninstall the NSWL client, at the command prompt, run the following command from the <NSWL-HOME>\bin directory:

> nswl -remove

Install NSWL client on AIX system

To install the NSWL client, perform the following operations on the system where you downloaded the package.

  1. Extract the nswl_aix-<release number>-<build number>.rpm file from the package.
  2. Copy the extracted file to a system, running AIX OS, on which you want to install the NSWL client.
  3. To install the NSWL package, execute the following command:

rpm -i nswl_aix-9.3-51.5.rpm

This command extracts the files and installs them in the following directories.

  • /usr/local/netscaler/etc
  • /usr/local/netscaler/
  • usr/local/netscaler/samples

Note: To uninstall the NSWL package, execute the following command:

rpm -e NSweblog

Note: To get more information about the NSweblog RPM file, execute the following command:

rpm -qpi *.rpm

Note: To view the installed Web server logging files, execute the following command:

rpm -qpl *.rpm

Installing the Citrix ADC web logging (NSWL) client