Running the Nswl Client | Citrix Systems CITRIX NETSCALER 9.3

Citrix NetScaler Administration Guide

Verifying the NSWL Configuration File

To make sure that logging works correctly, check the NSWL configuration file (log.conf) on the client system for syntax errors.

To verify the configuration in the NSWL configuration file

At the client system command prompt, type: nswl -verify -f <directorypath>\log.conf

< directorypath >: Specifies the path to the configuration file (log.conf).

Running the NSWL Client

To start Web server logging

At the client system command prompt, type: nswl -start -f <directorypath>\log.conf

<directorypath>: Specifies the path to the configuration file ( log.conf).

To stop Web server logging started as a background process on the Solaris or Linux operating systems

At the command prompt, type:

nswl -stop

To stop Web server logging started as a service on the Windows operating system

At the command prompt, type:

nswl -stopservice

Customizing Logging on the NSWL Client System

You can customize logging on the NSWL client system by making additional modifications to the NSWL client configuration file (log.conf). Use a text editor to modify the log.conf configuration file on the client system.

105

Image 105

Citrix Systems CITRIX NETSCALER 9.3 manual Running the Nswl Client, Customizing Logging on the Nswl Client System

Contents

Citrix NetScaler Administration Guide Copyright and Trademark Notice Page Page Contents Snmp Vii Audit Logging Web Server Logging 105 Advanced Configurations Contents Web Interface AppFlow Reporting Tool Contents Xvi Formatting Conventions for NetScaler Documentation This PrefaceFormatting Conventions Meaning Boldface Documentation Available on the NetScaler Appliance ConventionTo view the documentation Getting Service and Support NetScaler Documentation FeedbackTo provide feedback at the Knowledge Center home Preface Topics Authentication and Authorization Configuring Users and Groups Configuring User AccountsShow system user Example Password Password Parameters for configuring a user accountTimeout CLI Idle Session Timeout Secs UserName User Name Configuring User Groups To create a user group by using the NetScaler command lineShow system group Example Show system group groupName Example Show system group groupName Parameters for configuring a user groupGroupName Group Name UserName Configuring Command Policies Built-in Command PoliciesCLI Prompt CLI Idle Session Timeout Secs Built-in Command Policies Policy name Allows Creating Custom Command PoliciesExcept show runningconfig, show Runningconfig, and sh gslb Command specification regular expression Matches these commands Sh system cmdPolicy Example Parameters for configuring a command policyPolicyname Action Binding Command Policies to Users and Groups Sh system user userName Example Parameters for binding a command policy to a userSh system user userName Priority Sh system group groupName Example Parameters for binding a command policy to a groupSh system group groupName GroupName To reset the nsroot password Resetting the Default Administrator nsroot Password Fsck /dev/ad0s1a Mount /dev/ad0s1a /flash Example of a User Scenario Sample Values for Creating Entities Field Configuration steps Configuring External User Authentication Configuring Ldap Authentication Examples of Base Distinguished Name Ldap server Base DN Examples of Bind Distinguished Name Ldap serverBind DN Authentication Type, select LDAP. Next to Server, click New Determining attributes in the Ldap directory Configuring Radius Authentication Choosing Radius authentication protocolsAuthentication Type, select Radius Configuring IP address extraction Configuring TACACS+ Authentication Configuring NT4 AuthenticationAuthentication Type, select Tacacs Authentication Type, select NT4 Authentication and Authorization Snmp Importing MIB Files to the Snmp Manager and Trap Listener Enable snmp alarm alarm name Sh snmp alarm alarm name Enabling or Disabling an Snmp Alarm To configure an Snmp alarm by using the command line Configuring AlarmsParameters for configuring Snmp alarms Severity Configuring Traps To configure Snmp alarms by using the configuration utilityTo add an Snmp trap by using the NetScaler command line To configure Snmp Traps by using the configuration utility Parameters for configuring Snmp traps Enabling Unconditional Snmp Trap Logging Specifying an Snmp Manager Configuring the NetScaler for Snmp v1 and v2 QueriesParameters for unconditional Snmp trap logging SnmpTrapLogging Snmp Trap Logging Show snmp manager To add an Snmp manager by using the NetScaler command line IPAddress Parameters for configuring an Snmp manager To add an Snmp manager by using the configuration utility Specifying an Snmp Community Parameters for configuring an Snmp community stringSh snmp community Permissions Configuring Snmp Alarms for Rate Limiting Configuring an Snmp Alarm for Throughput or PPSCommunity String*-communityName Show snmp alarm PF-RL-RATE-THRESHOLD ThresholdValue Show snmp alarm PF-RL-PPS-THRESHOLDNormalValue State Alarm Threshold-thresholdValue Normal Threshold-normalValue Configuring Snmp Alarm for Dropped Packets Parameters for configuring an Snmp alarm for dropped packets Configuring the NetScaler for SNMPv3 Queries Setting the Engine ID To set the engine ID by using the NetScaler command line Configuring a ViewParameters for setting the engine ID To set the engine ID by using configuration utility Configuring a Group Parameters for configuring an Snmp viewTo add an Snmp group by using the NetScaler command line Parameters for configuring an Snmp group Configuring a UserTo configure a user by using the NetScaler command line SecurityLevel Parameters for configuring an Snmp user Citrix NetScaler Administration Guide Snmp Audit Logging Audit Logging Configuring the NetScaler Appliance for Audit Logging Configuring Audit ServersShow audit syslogAction name Show audit nslogAction name Parameters for configuring auditing serversServerIP ServerPort Log levels defined Configuring Audit Policies To configure an auditing server actionTo configure a Syslog policy by using the command line To configure an Nslog policy by using the command line Parameters for configuring audit policiesRule Binding the Audit Policies Globally To configure an audit server policyParameters for binding the audit policies globally Name* name Server* action Configuring an Audit Message Action Configuring Policy-Based LoggingTo globally bind the audit policy Pre Requisites BypassSafetyCheck StringBuilderExprLogtoNewnslog Binding Audit Message Action to a Policy Installing and Configuring the Nslog Server Installing Nslog Server on the Linux Operating System Supported Platforms for the Nslog Server Operating systemSoftware requirements Installing Nslog Server on the FreeBSD Operating System Pkgdelete NSaudserver Pkginfo grep NSaudserver On the system, where you have downloaded the Nslog package To install Nslog server on a Windows operating system To uninstall the Nslog server on a Windows operating system Nslog Server Command OptionsAudserver -remove Audserver -stop Audserver -remove Specifies To add the IP addresses of the NetScaler appliance Verifying the Nslog Server Configuration File Running the Nslog ServerTo start audit server logging Customizing Logging on the Nslog Server Creating FiltersTo create a filter Specifying Log Properties Default Settings for the Log Properties Following is a sample configuration file Sample Configuration File audit.conf Web Server Logging Enabling or Disabling Web Server Logging Configuring the NetScaler Appliance for Web Server Logging Parameter for modifying the buffer size Modifying the Default Buffer SizeSh weblogparam Example Buffer Size Supported Platforms for the Nswl Client Operating system To modify the buffer size by using the configuration utility Installing Nswl Client on a Solaris Operating System Hardware requirementsCp pathtocd/Utilities/weblog/Solaris/NSweblog.tar /tmp Cd /tmp Installing Nswl Client on a Linux Operating SystemTar xvf NSweblog.tar Pkginfo grep NSweblog Installing Nswl Client on a FreeBSD Operating System To view the installed Web server logging filesTo get more information about the NSweblog RPM file Installing Nswl Client on a Mac OS Operating System Pkgdelete NSweblogCp pathtocd/Utilities/weblog/macos/NSweblog.tgz /tmp To install the Nswl client on a Windows system Installing Nswl Client on a Windows Operating System To uninstall the Nswl client on a Windows system Installing Nswl Client on an AIX Operating SystemCp pathtocd/Utilities/weblog/AIX/NSweblog.rpm /tmp Rpm -i NSweblog.rpm Nswl Command Options Nswl command Specifies Nswl Client Command Options Adding the IP Addresses of the NetScaler Appliance To add the Nsip address of the NetScaler applianceNswl -addns -f directorypath \log.conf To verify the configuration in the Nswl configuration file Verifying the Nswl Configuration FileRunning the Nswl Client Customizing Logging on the Nswl Client System On OFF Parameters for Creating a Filter Specifies To create a filter for a virtual server LogFormat Ncsa Ncsa Common Log Format Understanding the Ncsa and W3C Log Formats Ncsa Common Log Format Argument Specifies W3C Extended Log Format Entries DirectivesDirective Descriptions Identifiers FieldsPrefix Descriptions Specifies Examples Description W3C Extended Log Format Identifiers No Prefix Required Creating a Custom Log Format by Using the Nswl Library Creating a Custom Log FormatField Description Creating a Custom Log Format Manually To create the custom log format by using the Nswl Library Creating Apache Log Formats Sample Configuration File Ncsa 11.Custom Log Format Argument Specifies Arguments for Defining a Custom Log Format Foobari Foobaro Formatt 12.Time Format Definition Argument Specifies Time Format Definition Argument Specifies 123 Web Server Logging 124 Advanced Configurations Configuring Clock Synchronization To add an NTP server by using the NetScaler command lineShow ntp server Example ServerName Parameters for configuring an NTP serverMinpoll Maxpoll Configuring Clock Synchronization Manually Enable ntp sync Disable ntp syncStarting or Stopping the NTP Daemon Usr/sbin/ntpd -c /nsconfig/ntp.conf -l /var/log/ntpd.log Show ns config ExampleViewing the System Date and Time Configuring TCP Window Scaling Parameters for configuring window scaling Show ns tcpParam ExampleWSVal Enabled Configuring Selective Acknowledgment To enable Sack by using the Configuration Utility Clearing the Configuration To clear a configuration by using the configuration utility Parameters for clearing a configurationViewing the Http Band Statistics Level RespBandSize ReqBandSize To modify the band range by using the configuration utility Configuring Http ProfilesTo add an Http profile by using the NetScaler command line Built-in Http Profiles Built-in profile Description Parameters for adding an Http profile Configuring TCP Profiles To add an Http profile by using the configuration utilityBuilt-in TCP Profiles Built-in profile Description To add a TCP profile by using the NetScaler command line Parameters for creating a TCP profile To add a TCP profile by using the configuration utility Specifying a TCP Buffer Size Example BufferSize Parameters for setting the TCP buffer size in a TCP profile Specifying the MSS Value in a TCP Profile Parameters for specifying the MSS value in a TCP profileMss Learn MSS for VServer LearnVsvrMSS Advanced Configurations 148 Web Interface Prerequisites How Web Interface Works Installing the Web Interface Configuring the Web Interface Web Interface tar file pathJRE tar file path Parameters for configuring Web interface sites Authentication Point Gateway Direct ModeAccess Gateway URL Port XML Service Addresses Configuring a Web Interface Site for LAN Users Using HttpXML Service Port Transport Site Type Published Resource Type Kiosk Mode A Web Interface Site Configured for LAN Users Using Http Virtual Server Protocol select Https IP Address Port Add service WILoopbackService 127.0.0.1 Http A Web Interface Site Configured for LAN Users Using Https Configuring a Web Interface Site for LAN Users Using Https 160 161 Add lb vserver Httpswi SSL 10.102.29.3 Configuring a Web Interface Site for Remote Users Using Agee A Web Interface Site Configured for Remote Users Using Agee 165 166 AppFlow NetScaler Flow Sequence How AppFlow Works Templates Flow Records Configuring the AppFlow Feature Enabling or Disabling the AppFlow Feature To specify a collector by using the NetScaler command lineSpecifying a Collector To remove a collector by using the NetScaler command line Configuring an AppFlow ActionTo specify a collector by using the configuration utility Parameters for specifying a collector Parameters for configuring an AppFlow action CollectorsComment Show appflow policy name Configuring an AppFlow Policy Rule Action Parameters for configuring an AppFlow policy Http To add an expression by using the Add Expression dialog box Show appflow global Binding an AppFlow Policy GotoPriorityExpression Parameters for binding an AppFlow policyInvoke Invoke flag LabelType LabelName Click Apply Changes Enabling AppFlow for Virtual Servers Setting the AppFlow Parameters Enabling AppFlow for a Service AppFlow Parameters HttpReferer HttpCookieHttpMethod HttpHost Reporting Tool Using the Reporting Tool To invoke the Reporting toolWorking with Reports Creating and Deleting Reports Using Built-in Reports Time Intervals Time interval Displays Modifying the Time Interval Exporting and Importing Custom Reports Setting the Data Source and Time Zone Working with Charts Adding a ChartModifying a Chart To change the graph type of a chart Viewing a Chart To view numeric data for a graph To change the color and graph type of a data set Deleting a Chart To export chart data to ExcelExamples Limits on Entity Numbers Retrieved by nscollect Entity name Stopping and Starting the Data Collection Utility To start nscollect on the local system To stop nscollectEntity name Limit Netscaler/nscollect stop Netscaler/nscollect start To start nscollect on the remote system