Citrix Systems CITRIX NETSCALER 9.3 Customizing Logging on the Nslog Server, Creating Filters

Page 89

Citrix NetScaler Administration Guide

audserver -stopservice

Customizing Logging on the NSLOG Server

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

To customize logging, use the configuration file to define filters and log properties.

wLog filters. Filter log information from a NetScaler appliance or a set of NetScaler appliances.

wLog properties. Each filter has an associated set of log properties. Log properties define how to store the filtered log information.

Creating Filters

You can use the default filter definition located in the configuration file (audit log.conf ), or you can modify the filter or create a new filter. You can create more than one log filter.

Note: For consolidated logging, if a log transaction occurs for which there is no filter definition, the default filter is used (if it is enabled.) The only way you can configure consolidated logging of all the Citrix NetScaler appliances is by defining the default filter.

To create a filter

At the command prompt, type the following command in the configuration file

(auditlog.conf) :

filter <filterName> [IP <ip>] [NETMASK <mask>] [ON OFF]

<filterName>: Specify the name of the filter (maximum of 64 alphanumeric characters).

<ip>: Specify the IP addresses.

<mask>: Specify the subnet mask to be used on a subnet.

Specify ON to enable the filter to log transactions, or specify OFF to disable the filter. If no argument is specified, the filter is ON

Examples

filter F1 IP 192.168.100.151 ON

To apply the filter F2 to IP addresses 192.250.100.1 to 192.250.100.254:

filter F2 IP 192.250.100.0 NETMASK 255.255.255.0 ON

89

Image 89

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 Meaning Boldface Formatting Conventions for NetScaler DocumentationThis Preface To view the documentation Documentation Available on the NetScaler ApplianceConvention To provide feedback at the Knowledge Center home Getting Service and SupportNetScaler Documentation Feedback Preface Topics Authentication and AuthorizationShow system user Example Configuring Users and GroupsConfiguring User Accounts Password Password Parameters for configuring a user accountTimeout CLI Idle Session Timeout Secs UserName User NameShow system group Example Configuring User GroupsTo create a user group by using the NetScaler command line Show system group groupName Example Show system group groupName Parameters for configuring a user groupGroupName Group Name UserNameCLI Prompt CLI Idle Session Timeout Secs Configuring Command PoliciesBuilt-in Command Policies Built-in Command Policies Policy name Allows Creating Custom Command PoliciesExcept show runningconfig, show Runningconfig, and sh gslbCommand specification regular expression Matches these commandsSh system cmdPolicy Example Parameters for configuring a command policyPolicyname ActionBinding Command Policies to Users and Groups Sh system user userName Example Parameters for binding a command policy to a userSh system user userName PrioritySh system group groupName Example Parameters for binding a command policy to a groupSh system group groupName GroupNameTo reset the nsroot password Resetting the Default Administrator nsroot PasswordFsck /dev/ad0s1a Mount /dev/ad0s1a /flash Example of a User ScenarioSample Values for Creating Entities Field Configuration stepsConfiguring External User Authentication Configuring Ldap Authentication Bind DN Examples of Base Distinguished Name Ldap server Base DNExamples of Bind Distinguished Name Ldap server Authentication Type, select LDAP. Next to Server, click New Determining attributes in the Ldap directory Authentication Type, select Radius Configuring Radius AuthenticationChoosing Radius authentication protocols Configuring IP address extraction Authentication Type, select Tacacs Configuring TACACS+ AuthenticationConfiguring NT4 Authentication 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 AlarmTo configure an Snmp alarm by using the command line Configuring AlarmsParameters for configuring Snmp alarms SeverityTo add an Snmp trap by using the NetScaler command line Configuring TrapsTo configure Snmp alarms by using the configuration utility To configure Snmp Traps by using the configuration utility Parameters for configuring Snmp trapsEnabling 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 LoggingShow snmp manager To add an Snmp manager by using the NetScaler command lineIPAddress Parameters for configuring an Snmp managerTo add an Snmp manager by using the configuration utility Specifying an Snmp Community Parameters for configuring an Snmp community stringSh snmp community PermissionsCommunity String*-communityName Configuring Snmp Alarms for Rate LimitingConfiguring an Snmp Alarm for Throughput or PPS Show snmp alarm PF-RL-RATE-THRESHOLD ThresholdValue Show snmp alarm PF-RL-PPS-THRESHOLDNormalValue StateAlarm Threshold-thresholdValue Normal Threshold-normalValue Configuring Snmp Alarm for Dropped PacketsParameters for configuring an Snmp alarm for dropped packets Configuring the NetScaler for SNMPv3 QueriesSetting 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 utilityTo add an Snmp group by using the NetScaler command line Configuring a GroupParameters for configuring an Snmp view Parameters for configuring an Snmp group Configuring a UserTo configure a user by using the NetScaler command line SecurityLevelParameters for configuring an Snmp user Citrix NetScaler Administration Guide Snmp Audit Logging Audit Logging Show audit syslogAction name Configuring the NetScaler Appliance for Audit LoggingConfiguring Audit Servers Show audit nslogAction name Parameters for configuring auditing serversServerIP ServerPortLog levels defined To configure a Syslog policy by using the command line Configuring Audit PoliciesTo configure an auditing server action Rule To configure an Nslog policy by using the command lineParameters for configuring audit policies Binding the Audit Policies Globally To configure an audit server policyParameters for binding the audit policies globally Name* name Server* actionConfiguring an Audit Message Action Configuring Policy-Based LoggingTo globally bind the audit policy Pre RequisitesLogtoNewnslog BypassSafetyCheckStringBuilderExpr Binding Audit Message Action to a Policy Installing and Configuring the Nslog ServerSoftware requirements Installing Nslog Server on the Linux Operating SystemSupported Platforms for the Nslog Server Operating system Installing Nslog Server on the FreeBSD Operating System Pkgdelete NSaudserver Pkginfo grep NSaudserverOn the system, where you have downloaded the Nslog package To install Nslog server on a Windows operating systemTo uninstall the Nslog server on a Windows operating system Nslog Server Command OptionsAudserver -remove Audserver -stopAudserver -remove Specifies To add the IP addresses of the NetScaler applianceTo start audit server logging Verifying the Nslog Server Configuration FileRunning the Nslog Server To create a filter Customizing Logging on the Nslog ServerCreating Filters Specifying Log Properties Default Settings for the Log Properties Following is a sample configuration file Sample Configuration File audit.confWeb Server Logging Enabling or Disabling Web Server Logging Configuring the NetScaler Appliance for Web Server LoggingParameter for modifying the buffer size Modifying the Default Buffer SizeSh weblogparam Example Buffer SizeSupported Platforms for the Nswl Client Operating system To modify the buffer size by using the configuration utilityCp pathtocd/Utilities/weblog/Solaris/NSweblog.tar /tmp Installing Nswl Client on a Solaris Operating SystemHardware requirements Cd /tmp Installing Nswl Client on a Linux Operating SystemTar xvf NSweblog.tar Pkginfo grep NSweblogTo get more information about the NSweblog RPM file Installing Nswl Client on a FreeBSD Operating SystemTo view the installed Web server logging files Cp pathtocd/Utilities/weblog/macos/NSweblog.tgz /tmp Installing Nswl Client on a Mac OS Operating SystemPkgdelete NSweblog To install the Nswl client on a Windows system Installing Nswl Client on a Windows Operating SystemTo 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.rpmNswl Command Options Nswl command Specifies Nswl Client Command OptionsNswl -addns -f directorypath \log.conf Adding the IP Addresses of the NetScaler ApplianceTo add the Nsip address of the NetScaler appliance To verify the configuration in the Nswl configuration file Verifying the Nswl Configuration FileRunning the Nswl Client Customizing Logging on the Nswl Client SystemOn OFF Parameters for Creating a Filter SpecifiesTo create a filter for a virtual server LogFormat Ncsa Ncsa Common Log Format Understanding the Ncsa and W3C Log FormatsNcsa Common Log Format Argument Specifies W3C Extended Log FormatDirective Descriptions EntriesDirectives Identifiers FieldsPrefix Descriptions Specifies ExamplesDescription W3C Extended Log Format Identifiers No Prefix RequiredField Description Creating a Custom Log Format by Using the Nswl LibraryCreating a Custom Log Format Creating a Custom Log Format Manually To create the custom log format by using the Nswl LibraryCreating Apache Log Formats Sample Configuration FileNcsa 11.Custom Log Format Argument Specifies Arguments for Defining a Custom Log FormatFoobari Foobaro Formatt 12.Time Format Definition Argument Specifies Time Format DefinitionArgument Specifies 123 Web Server Logging 124 Advanced Configurations Show ntp server Example Configuring Clock SynchronizationTo add an NTP server by using the NetScaler command line ServerName Parameters for configuring an NTP serverMinpoll MaxpollStarting or Stopping the NTP Daemon Configuring Clock Synchronization ManuallyEnable ntp sync Disable ntp sync Viewing the System Date and Time Usr/sbin/ntpd -c /nsconfig/ntp.conf -l /var/log/ntpd.logShow ns config Example Configuring TCP Window Scaling WSVal Parameters for configuring window scalingShow ns tcpParam Example Enabled Configuring Selective AcknowledgmentTo enable Sack by using the Configuration Utility Clearing the ConfigurationTo clear a configuration by using the configuration utility Parameters for clearing a configurationViewing the Http Band Statistics LevelRespBandSize ReqBandSizeTo 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 DescriptionParameters for adding an Http profile Built-in TCP Profiles Built-in profile Description Configuring TCP ProfilesTo add an Http profile by using the configuration utility 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 profileMss Specifying the MSS Value in a TCP ProfileParameters for specifying the MSS value in a TCP profile Learn MSS for VServer LearnVsvrMSS Advanced Configurations 148 Web Interface Prerequisites How Web Interface WorksInstalling the Web Interface JRE tar file path Configuring the Web InterfaceWeb Interface tar file path Parameters for configuring Web interface sites Authentication Point Gateway Direct ModeAccess Gateway URL PortXML Service Addresses Configuring a Web Interface Site for LAN Users Using HttpXML Service Port TransportSite Type Published Resource Type Kiosk Mode A Web Interface Site Configured for LAN Users Using HttpVirtual 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 Https160 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 WorksTemplates Flow RecordsConfiguring the AppFlow Feature Specifying a Collector Enabling or Disabling the AppFlow FeatureTo specify a collector by using the NetScaler command line 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 collectorComment Parameters for configuring an AppFlow actionCollectors Show appflow policy name Configuring an AppFlow PolicyRule Action Parameters for configuring an AppFlow policyHttp To add an expression by using the Add Expression dialog boxShow appflow global Binding an AppFlow PolicyGotoPriorityExpression Parameters for binding an AppFlow policyInvoke Invoke flag LabelType LabelNameClick Apply Changes Enabling AppFlow for Virtual ServersSetting the AppFlow Parameters Enabling AppFlow for a ServiceAppFlow Parameters HttpReferer HttpCookieHttpMethod HttpHostReporting Tool Working with Reports Using the Reporting ToolTo invoke the Reporting tool Creating and Deleting Reports Using Built-in ReportsTime Intervals Time interval Displays Modifying the Time IntervalExporting and Importing Custom Reports Setting the Data Source and Time ZoneModifying a Chart Working with ChartsAdding a Chart To change the graph type of a chart Viewing a ChartTo view numeric data for a graph To change the color and graph type of a data set Examples Deleting a ChartTo export chart data to Excel Limits on Entity Numbers Retrieved by nscollect Entity name Stopping and Starting the Data Collection UtilityTo start nscollect on the local system To stop nscollectEntity name Limit Netscaler/nscollect stopNetscaler/nscollect start To start nscollect on the remote system