Installing the NetScaler web logging (NSWL) client

During installation, the NSWL 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 NetScaler. For example, if the version of the NetScaler is 10.1 Build 125.9, the NSWL client must also be of the same version. Also, Citrix ADC web logging (NSWL) client works only on 32 bit appliance and not on 64 bit appliance.

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

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 a NSWL client system bottleneck caused by a CPU limitation, you can tune the Web server logging buffer size on the NetScaler appliance. To solve the problem, you need a client system that can handle the site’s throughput.

Downloading the NSWL client

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

To download the NSWL client package from the Citrix site

1. Open the URL https://www.citrix.com/downloads.html.
2. Log in to the site using your credentials.
3. Open the page for the required release number and build.
4. In the page, under Weblog Clients, click Download. The package has the name format as follows: Weblog- <release number>-<build number>.zip.

Installing the NSWL client on a Solaris system

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.

4. 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 NetScaler Weblogging (SunOS,sparc) 7.0
   

5. 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

6. 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
   

Installing the NSWL Client on a Linux System

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

Installing the NSWL client on a FreeBSD system

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
   

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

   pkg_info | grep NSweblog
   

Installing the NSWL Client on a Mac System

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 Mac OS, 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
   

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

   pkg_info | grep NSweblog
   

Installing the NSWL client on a Windows system

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, 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,

   directorypath refers to the path of the configuration file (log.conf). By default, the file is in the <NSWL-HOME> 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
   

Installing the NSWL client on a 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