Manuals / Citrix Systems / Computer Equipment / Network Router

Citrix Systems CITRIX NETSCALER 9.3 manual Citrix NetScaler Administration Guide

Models: CITRIX NETSCALER 9.3

1 195

Page 123

Citrix NetScaler Administration Guide

The difference between %U and %W (and also between modified conversions %OU and %OW) is the day considered to be the first day of the week. Week number 1 is the first week in January (starting with a Sunday for %U, or a Monday for %W). Week number 0 contains the days before the first Sunday or Monday in January for %U and %W.

123

Page 123

Image 123

Citrix Systems CITRIX NETSCALER 9.3 manual Citrix NetScaler Administration Guide

Contents

Citrix NetScaler Citrix NetScaler Administration GuideCopyright and Trademark Notice All rights reserved Last Updated March Document code May 21 2012 Page Contents 1 Authentication and AuthorizationPreface 2 SNMP ContentsEnabling Unconditional SNMP Trap Logging Citrix NetScaler Administration Guideviii Contents3 Audit Logging 4 Web Server Logging Citrix NetScaler Administration GuideInstalling and Configuring the Client System for Web Server Logging. . . . . . . . . . . . . . . . . . . . . 96 Installing NSWL Client on a Solaris Operating System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .97 To install the NSWL client package on a Solaris operating system. . . . . . . . . . . . . . 97 To uninstall the NSWL client package on a Solaris operating system ContentsConfiguring TCP Window Scaling xi Citrix NetScaler Administration Guide5 Advanced Configurations Contents 6 Web Interface Specifying the MSS Value in a TCP Profilexiii Citrix NetScaler Administration Guide7 AppFlow Enabling AppFlow for Virtual Servers179 xiv Contents8 Reporting Tool Citrix NetScaler Administration GuideContents Table 1. Formatting Conventions PrefaceFormatting Conventions for NetScaler Documentation In This PrefaceConvention Documentation Available on the NetScaler AppliancePreface To view the documentationGetting Service and Support NetScaler Documentation FeedbackTo provide feedback at the Knowledge Center home page Preface Example of a User Scenario Configuring External User Authentication Authentication and AuthorizationConfiguring Users and Groups Configuring Command Policies Resetting the Default Administrator nsroot Passwordw show system user Example Configuring Users and GroupsConfiguring User Accounts To create a user account by using the NetScaler command lineuserName User Name Parameters for configuring a user accountpassword Password timeout CLI Idle Session Timeout SecsPassword Confirm Password CLI Prompt CLI Idle Session Timeout Secs Configuring User GroupsTo configure a user account by using the configuration utility To create a user group by using the NetScaler command linew show system group groupName Example To modify or remove a user group by using the NetScaler command lineTo bind a user to a group by using the NetScaler command line To unbind a user from a group by using the NetScaler command linegroupName Group Name Parameters for configuring a user groupTo configure a user group by using the configuration utility w show system group groupNameConfiguring Command Policies Built-in Command PoliciesCLI Prompt CLI Idle Session Timeout Secs runningconfig, and sh gslb Creating Custom Command PoliciesTable 1-1. Built-in Command Policies except show runningconfig, showTable 1-3. Expressions Used in the Built-in Command Policies Table 1-2. Examples of Regular Expressions for Command PoliciesCommand specification Matches these commandspolicyname To create a command policy by using the NetScaler command lineParameters for configuring a command policy w sh system cmdPolicy ExampleTo configure a command policy by using the configuration utility Binding Command Policies to Users and Groupsw sh system user userName Parameters for binding a command policy to a userTo bind command policies to a user by using the configuration utility w sh system user userName ExampleParameters for binding a command policy to a group To reset the nsroot password Resetting the Default Administrator nsroot Passwordfsck /dev/ad0s1a mount /dev/ad0s1a /flash Example of a User ScenarioField Configuration stepsmodifyall with action as Allow and the command spec \S+\s+?!system Table 1-4. Sample Values for Creating EntitiesConfiguring External User Authentication Configuring LDAP Authentication Case sensitive? Table 1-5. User Attribute Fields for LDAP ServersLDAP server User attributeBind DN To configure LDAP authentication by using the configuration utility4. In Authentication Type, select LDAP. Next to Server, click New LDAP serverDetermining attributes in the LDAP directory 4. In Authentication Type, select RADIUS Configuring RADIUS AuthenticationTo configure RADIUS authentication by using the configuration utility Choosing RADIUS authentication protocolsConfiguring IP address extraction To configure IP address extraction by using the configuration utility4. Under Details, in Group Vendor Identifier, type the value Configuring TACACS+ Authentication Configuring NT4 Authentication4. In Authentication Type, select TACACS To configure NT4 authentication by using the configuration utility Binding the Authentication Policies to the System Global Entity2. On the Policies tab, click Global Bindings Chapter 1 Authentication and AuthorizationConfiguring the NetScaler for SNMPv3 Queries Configuring the NetScaler to Generate SNMPv1 and SNMPv2 TrapsConfiguring the NetScaler for SNMP v1 and v2 Queries Configuring SNMP Alarms for Rate LimitingConfiguring the NetScaler to Generate SNMPv1 and SNMPv2 Traps Importing MIB Files to the SNMP Manager and Trap ListenerTo import the MIB files to the SNMP manager and trap listener w enable snmp alarm alarm name w sh snmp alarm alarm name Enabling or Disabling an SNMP AlarmTo enable or disable an SNMP alarm by using the command line To enable or disable an SNMP alarm by using the configuration utilityw sh snmp alarm alarm Name Configuring AlarmsTo configure an SNMP alarm by using the command line Parameters for configuring SNMP alarmsConfiguring Traps To configure SNMP alarms by using the configuration utilityTo add an SNMP trap by using the NetScaler command line trapClass Parameters for configuring SNMP trapsTo configure SNMP Traps by using the configuration utility w show snmp trapSource IP Address-srcIP Minimum Severity-severity w set snmp option -snmpTrapLogging ENABLED DISABLEDEnabling Unconditional SNMP Trap Logging Destination IP Address*-trapDestination Destination Port-destPortSnmpTrapLogging SNMP Trap Logging Configuring the NetScaler for SNMP v1 and v2 QueriesSpecifying an SNMP Manager Parameters for unconditional SNMP trap loggingTo add an SNMP manager by using the NetScaler command line w show snmp managerw show snmp manager Parameters for configuring an SNMP manager IPAddressw show snmp manager IP Address*-IPAddress To add an SNMP manager by using the configuration utilitynetmask domainResolveRetryw sh snmp community To specify an SNMP community by using the NetScaler command lineParameters for configuring an SNMP community string Specifying an SNMP CommunityCommunity String*-communityName Configuring SNMP Alarms for Rate LimitingConfiguring an SNMP Alarm for Throughput or PPS To remove an SNMP community string by using the configuration utilityw show snmp alarm PF-RL-RATE-THRESHOLD normalValue Parameters for configuring an SNMP alarm for throughput or PPSw show snmp alarm PF-RL-PPS-THRESHOLD thresholdValueConfiguring SNMP Alarm for Dropped Packets severity Configuring the NetScaler for SNMPv3 QueriesParameters for configuring an SNMP alarm for dropped packets stateSetting the Engine ID To set the engine ID by using configuration utility Configuring a ViewTo set the engine ID by using the NetScaler command line Parameters for setting the engine IDTo add an SNMP group by using the NetScaler command line Configuring a GroupParameters for configuring an SNMP view To configure an SNMP view by using the configuration utilityTo configure a user by using the NetScaler command line Configuring a UserParameters for configuring an SNMP group To configure an SNMP group by using the configuration utilityAuthentication Password-authPasswd Privacy Type-privType Parameters for configuring an SNMP userTo configure an SNMP user by using the configuration utility Name*-name Group Name*-group Authentication Type-authTypeA required parameter 4. Click Create or OK, and then click Close Citrix NetScaler Administration GuideChapter 2 SNMP Sample Configuration File audit.conf Configuring the NetScaler Appliance for Audit LoggingInstalling and Configuring the NSLOG Server Running the NSLOG Server Default Settings for the Log PropertiesChapter 3 Audit Logging w show audit syslogAction name Configuring the NetScaler Appliance for Audit LoggingConfiguring Audit Servers To configure a SYSLOG server action by using the command lineserverIP To configure an NSLOG server action by using the command lineParameters for configuring auditing servers w show audit nslogAction namelogFacility ERRORLog levels defined dateFormatUser Configurable Log Messages-userDefinedAuditlog Configuring Audit PoliciesTo configure an auditing server action To configure a SYSLOG policy by using the command linew show audit syslogPolicy name To configure an NSLOG policy by using the command lineParameters for configuring audit policies w add audit syslogPolicy name rule actionName* name Server* action To configure an audit server policyBinding the Audit Policies Globally Parameters for binding the audit policies globallyTo globally bind the audit policy Configuring Policy-Based LoggingConfiguring an Audit Message Action To create an audit message action by using the NetScaler command linestringBuilderExpr Parameters for configuring an audit message actionbypassSafetyCheck ExampleInstalling and Configuring the NSLOG Server Binding Audit Message Action to a PolicyName*-name Log Level*-logLevel Operating system Installing NSLOG Server on the Linux Operating SystemTo install the NSLOG server package on a Linux operating system Table 3-1. Supported Platforms for the NSLOG ServerTo uninstall the NSLOG server package on a Linux operating system Installing NSLOG Server on the FreeBSD Operating Systempkgadd audserverbsd-release number-build number.tgz Example Installing NSLOG Server Files on the Windows Operating SystemTo install the NSLOG server package on a FreeBSD operating system To uninstall the NSLOG server package on a FreeBSD operating systemCitrix NetScaler Administration Guide To install NSLOG server on a Windows operating systemaudserver -remove NSLOG Server Command OptionsTo uninstall the NSLOG server on a Windows operating system Audit server commandsaudserver -remove Adding the NetScaler Appliance IP Addresses on the NSLOG ServerTo add the IP addresses of the NetScaler appliance Audit server commandsTo start audit server logging Verifying the NSLOG Server Configuration FileTo stop audit server logging that starts as a service in Windows Running the NSLOG ServerCustomizing Logging on the NSLOG Server Creating FiltersTo create a filter Specifying Log Properties ExampleExample Example Default Settings for the Log PropertiesExample ExampleSample Configuration File audit.conf ExampleExample Web Server Logging Configuring the NetScaler Appliance for Web Server LoggingInstalling and Configuring the Client System for Web Server Logging Sample Configuration File Arguments for Defining a Custom Log FormatWeb Logging Configuring the NetScaler Appliance for Web Server Loggingw enable ns feature WL w disable ns feature WL w sh ns feature Enabling or Disabling Web Server Loggingw sh weblogparam Example Modifying the Default Buffer SizeTo modify the buffer size by using the NetScaler command line Parameter for modifying the buffer sizeVersion Installing and Configuring the Client System for Web Server LoggingTo modify the buffer size by using the configuration utility Table 4-1. Supported Platforms for the NSWL Clientcp pathtocd/Utilities/weblog/Solaris/NSweblog.tar /tmp Installing NSWL Client on a Solaris Operating SystemTo install the NSWL client package on a Solaris operating system Hardware requirementscd /tmp Installing NSWL Client on a Linux Operating SystemTo uninstall the NSWL client package on a Solaris operating system To install the NSWL client package on a Linux operating systemTo install the NSWL client package on a FreeBSD operating system Installing NSWL Client on a FreeBSD Operating SystemTo uninstall the NSWL client package on a Linux operating system To view the installed Web server logging filespkgdelete NSweblog Installing NSWL Client on a Mac OS Operating SystemTo uninstall the NSWL client package on a FreeBSD operating system To install the NSWL client package on a Mac OS operating systempkgdelete NSweblog Installing NSWL Client on a Windows Operating SystemTo uninstall the NSWL client package on a Mac OS operating system To install the NSWL client on a Windows systemTo uninstall the NSWL client package on an AIX operating system Installing NSWL Client on an AIX Operating SystemTo uninstall the NSWL client on a Windows system To install the NSWL client package on an AIX operating systemTo view the installed Web server logging files NSWL Client Command OptionsTable 4-3. NSWL Command Options NSWL commandNSWL command Adding the IP Addresses of the NetScaler ApplianceTo add the NSIP address of the NetScaler appliance nswl -addns -f directorypath \log.confCustomizing Logging on the NSWL Client System Verifying the NSWL Configuration FileTo verify the configuration in the NSWL configuration file Running the NSWL ClientSpecifies Table 4-4. Parameters for Creating a FilterParameter Creating FiltersTo create a filter To create a filter for a virtual serverTo create a filter, enter the following command in the log.conf file Specifying Log PropertiesChapter 4 Web Server Logging ExampleExample Example Understanding the NCSA and W3C Log FormatsNCSA Common Log Format ExampleSpecifies W3C Extended Log FormatTable 4-5. NCSA Common Log Format ArgumentDirective EntriesDirectives Table 4-6. Directive DescriptionsPrefix FieldsIdentifiers Table 4-7. Prefix DescriptionsTable 4-10. W3C Extended Log File Format Allows Log Fields Table 4-8. W3C Extended Log Format Identifiers No Prefix RequiredIdentifier Table 4-9. W3C Extended Log Format Identifiers Requires a PrefixDescription Creating a Custom Log Format by Using the NSWL LibraryCreating a Custom Log Format FieldTo create the custom log format by using the NSWL Library Creating a Custom Log Format ManuallyExample Creating Apache Log Formats Sample Configuration FileCitrix NetScaler Administration Guide Specifies Arguments for Defining a Custom Log FormatTable 4-11. Custom Log Format ArgumentArgument b d g h H Foobari j J l m M Foobaro p qSpecifies Argument r s t formatt T u U v V V6Specifies Specifies Time Format DefinitionTable 4-12. Time Format Definition ArgumentChapter 4 Web Server Logging ArgumentSpecifies Citrix NetScaler Administration Guide Chapter 4 Web Server Logging Clearing the Configuration Viewing the HTTP Band Statistics Advanced ConfigurationsConfiguring Clock Synchronization Viewing the System Date and Time Configuring TCP Window Scaling Configuring Selective AcknowledgmentConfiguring Clock Synchronization To add an NTP server by using the NetScaler command linew show ntp server Example serverName To modify or remove NTP servers by using the NetScaler command lineParameters for configuring an NTP server To configure an NTP server by using the configuration utilityConfiguring Clock Synchronization Manually w enable ntp sync w disable ntp syncStarting or Stopping the NTP Daemon Viewing the System Date and Time To view the system date and time by using the NetScaler command lineusr/sbin/ntpd -c /nsconfig/ntp.conf -l /var/log/ntpd.log show ns config ExampleConfiguring TCP Window Scaling To view the system date and time by using the configuration utilitySystem Time Tue Feb 165044 WSVal To configure window scaling by using the NetScaler command lineParameters for configuring window scaling w show ns tcpParam ExampleSACK status Configuring Selective AcknowledgmentTo configure window scaling by using the configuration utility ENABLEDClearing the Configuration To enable SACK by using the Configuration UtilityTo clear a configuration by using the NetScaler command line level Parameters for clearing a configurationTo clear a configuration by using the configuration utility Viewing the HTTP Band StatisticsTo modify the band range by using the NetScaler command line Table 5-1. Built-in HTTP Profiles Configuring HTTP ProfilesTo modify the band range by using the configuration utility To add an HTTP profile by using the NetScaler command linemaxReusePool Max Connection in reusepool ENABLED DISABLED w sh ns httpProfile ExampleParameters for adding an HTTP profile name NameBuilt-in profile Configuring TCP ProfilesTo add an HTTP profile by using the configuration utility Table 5-2. Built-in TCP ProfilesTo add a TCP profile by using the NetScaler command line Built-in profileDescription WS Window Scaling delayedAck TCP Delayed ACK Time-out msecParameters for creating a TCP profile w sh ns tcpProfile ExampleminRTO Minimum RTO in millisec To add a TCP profile by using the configuration utilityInitial Congestion Window Size TCP Delayed ACK Time-out msec pktPerRetx Maximum Packets per Retransmissionw show ns tcpProfile name Specifying a TCP Buffer SizeUse Nagles Algorithm Immediate ACK on Receiving Packet with PUSH w set ns tcpProfile name -bufferSize positiveinteger12000 w set ns tcpProfile nstcpdefaultprofile -bufferSize positiveintegerw show ns tcpProfile nstcpdefaultprofile ExampleParameters for setting the TCP buffer size in a TCP profile bufferSizename Parameters for specifying the MSS value in a TCP profile Specifying the MSS Value in a TCP ProfileENABLED Configuring the NetScaler to Learn the MSS Value from Bound Servicesw set ns tcpParam -learnVsvrMSS ENABLEDDISABLED w show ns tcpParam Learn MSS for VServerlearnVsvrMSS Chapter 5 Advanced Configurations Chapter How Web Interface Works Prerequisites Installing the Web InterfaceConfiguring the Web Interface Web InterfaceHow Web Interface Works PrerequisitesFigure 6-1. A Basic Web Interface Session Example Installing the Web InterfaceJRE tar file path Configuring the Web InterfaceParameters for installing the Web interface and JRE tar files Web Interface tar file pathSite Type Parameters for configuring Web interface sitesKiosk Mode Direct ModePort Gateway Direct ModeAuthentication Point Access Gateway URLTransport Configuring a Web Interface Site for LAN Users Using HTTPXML Service Addresses XML Service PortSite Type Published Resource Type Kiosk Mode Figure 6-2. A Web Interface Site Configured for LAN Users Using HTTPVirtual Server Protocol select HTTPS IP Address Port XML Service Addresses XML Service Port Transport Load BalanceExample ExampleExample ExampleFigure 6-3. A Web Interface Site Configured for LAN Users Using HTTPS Configuring a Web Interface Site for LAN Users Using HTTPSSite Type Published Resource Type Kiosk Mode Chapter 6 Web InterfaceVirtual Server Protocol select HTTPS IP Address Port Example XML Service Addresses XML Service Port Transport Load BalanceExample ExampleExample ExampleExample ExampleConfiguring a Web Interface Site for Remote Users Using AGEE ExampleExample Site Type Published Resource Type Kiosk Mode XML Service Addresses XML Service Port Transport Load Balance Authentication Point Access Gateway URL Add DNS EntryTrust SSL Certificate STA Server URL STA Server URL Session Reliability Use two STA ServersChapter 6 Web Interface ExampleExample Topics How AppFlow Works Configuring the AppFlow FeatureAppFlow ChapterFigure 7-1. NetScaler Flow Sequence How AppFlow WorksconnectionID Flow RecordsTemplates transactionIDhttpUserAgent Configuring the AppFlow FeaturehttpRequestSize httpRequestURLw enable ns feature appflow w disable ns feature appflow Enabling or Disabling the AppFlow FeatureTo enable the AppFlow feature by using the configuration utility To specify a collector by using the NetScaler command lineTo configure an AppFlow action by using the NetScaler command line Configuring an AppFlow ActionTo remove a collector by using the NetScaler command line To specify a collector by using the configuration utility2 Name apfl-act-collector-2-and-3 Collectors collector-2, collecter-3 Parameters for configuring an AppFlow actionDone show appflow action 1 Name apfl-act-collector-1 Collectors collecter-1 Hits Action Reference Countw show appflow policy name Configuring an AppFlow PolicyTo configure an AppFlow action by using the configuration utility To configure an AppFlow policy by using the NetScaler command lineaction Parameters for configuring an AppFlow policyname rulecomment To configure an AppFlow policy by using the configuration utilityTo add an expression by using the Add Expression dialog box HTTPBinding an AppFlow Policy CLIENTw show appflow global invoke Invoke flag labelType To globally bind an AppFlow policy by using the configuration utilityParameters for binding an AppFlow policy gotoPriorityExpression6. Click Apply Changes To enable AppFlow for a virtual server by using theNetScaler command line Enabling AppFlow for Virtual ServersTo enable AppFlow for a service by using the configuration utility Enabling AppFlow for a ServiceSetting the AppFlow Parameters To enable AppFlow for a service by using the NetScaler command lineappnameRefresh AppFlow Parametersw show appflowParam templateRefreshhttpMethod To set the AppFlow parameters by using the configuration utilityhttpCookie httpRefererChapter Using the Reporting ToolReporting Tool Stopping and Starting the Data Collection UtilityWorking with Reports Using the Reporting ToolFigure 8-1. Report Toolbar Figure 8-2. Chart Toolbar To invoke the Reporting toolTo create a custom report Using Built-in ReportsCreating and Deleting Reports To display a built-in reportTime interval Modifying the Time IntervalTo delete a custom report Table 8-1. Time IntervalsTo set the data source and time zone Setting the Data Source and Time ZoneExporting and Importing Custom Reports To modify the time intervalTo add a chart to a report Working with ChartsAdding a Chart Modifying a ChartViewing a Chart To change the graph type of a chartTo refocus a chart with detailed data To view numeric data for a graph To scroll through time in a chartTo change the background color and text color of a chart To customize the axes of a chartExporting Chart Data to Excel To change the color and graph type of a data setCitrix NetScaler Administration Guide Examples Deleting a ChartTo delete a chart To export chart data to ExcelStopping and Starting the Data Collection Utility Table 8-2. Limits on Entity Numbers Retrieved by nscollectEntity name LimitEntity name To stop nscollectTo start nscollect on the local system netscaler/nscollect stopCitrix NetScaler Administration Guide netscaler/nscollect start -U 10.102.29.170nsrootnsroot -ds defaultTo start nscollect on the remote system netscaler/nscollect start