Citrix NetScaler SNMP Configuration Guide - SNMPv1, v2 and v3

Chapter 2

SNMP

Topics:

•Importing MIB Files to the SNMP Manager and Trap Listener

•Configuring the NetScaler to Generate SNMPv1 and SNMPv2 Traps

•Configuring the NetScaler for SNMP v1 and v2 Queries

•Configuring SNMP Alarms for Rate Limiting

•Configuring the NetScaler for SNMPv3 Queries

You can use Simple Network Management Protocol (SNMP) to configure the SNMP agent on the Citrix® NetScaler® appliance to generate asynchronous events, which are called traps. The traps are generated whenever there are abnormal conditions on the NetScaler. The traps are then sent to a remote device called a trap listener, which signals the abnormal condition on the NetScaler appliance. Or, you can query the SNMP agent for System-specific information from a remote device called an SNMP manager. The agent then searches the management information base (MIB) for the data requested and sends the data to the SNMP manager.

The SNMP agent on the NetScaler can generate traps compliant with SNMPv1 and SNMPv2 only. For querying, the SNMP agent supports SNMP version 1 (SNMPv1), SNMP version 2 (SNMPv2), and SNMP version 3 (SNMPv3).

The following figure illustrates a network with a NetScaler that has SNMP enabled and configured. In the figure, each SNMP network management application uses SNMP to communicate with the SNMP agent on the NetScaler. The SNMP agent searches its management information base (MIB) to collect the data requested by the SNMP Manager and provides the information to the application.

Figure 2-1.NetScaler Supporting SNMP

47

Image 47

Citrix Systems CITRIX NETSCALER 9.3 manual Snmp

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 Authorization Show system user Example Configuring Users and GroupsConfiguring User Accounts UserName User Name Parameters for configuring a user accountPassword Password Timeout CLI Idle Session Timeout Secs Show system group Example Configuring User GroupsTo create a user group by using the NetScaler command line Show system group groupName Example UserName Parameters for configuring a user groupShow system group groupName GroupName Group Name CLI Prompt CLI Idle Session Timeout Secs Configuring Command PoliciesBuilt-in Command Policies Runningconfig, and sh gslb Creating Custom Command PoliciesBuilt-in Command Policies Policy name Allows Except show runningconfig, show Command specification regular expression Matches these commands Action Parameters for configuring a command policySh system cmdPolicy Example Policyname Binding Command Policies to Users and Groups Priority Parameters for binding a command policy to a userSh system user userName Example Sh system user userName GroupName Parameters for binding a command policy to a groupSh system group groupName Example Sh system group 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 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 Alarm Severity Configuring AlarmsTo configure an Snmp alarm by using the command line Parameters for configuring Snmp alarms To 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 traps Enabling Unconditional Snmp Trap Logging SnmpTrapLogging Snmp Trap Logging Configuring the NetScaler for Snmp v1 and v2 QueriesSpecifying an Snmp Manager Parameters for unconditional 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 Permissions Parameters for configuring an Snmp community stringSpecifying an Snmp Community Sh snmp community Community String*-communityName Configuring Snmp Alarms for Rate LimitingConfiguring an Snmp Alarm for Throughput or PPS Show snmp alarm PF-RL-RATE-THRESHOLD State Show snmp alarm PF-RL-PPS-THRESHOLDThresholdValue NormalValue 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 configuration utility Configuring a ViewTo set the engine ID by using the NetScaler command line Parameters for setting the engine ID To add an Snmp group by using the NetScaler command line Configuring a GroupParameters for configuring an Snmp view SecurityLevel Configuring a UserParameters for configuring an Snmp group To configure a user by using the NetScaler command line Parameters 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 ServerPort Parameters for configuring auditing serversShow audit nslogAction name ServerIP Log 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 Name* name Server* action To configure an audit server policyBinding the Audit Policies Globally Parameters for binding the audit policies globally Pre Requisites Configuring Policy-Based LoggingConfiguring an Audit Message Action To globally bind the audit policy LogtoNewnslog BypassSafetyCheckStringBuilderExpr Binding Audit Message Action to a Policy Installing and Configuring the Nslog Server Software 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 NSaudserver On the system, where you have downloaded the Nslog package To install Nslog server on a Windows operating system Audserver -stop Nslog Server Command OptionsTo uninstall the Nslog server on a Windows operating system Audserver -remove Audserver -remove Specifies To add the IP addresses of the NetScaler appliance To 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.conf Web Server Logging Enabling or Disabling Web Server Logging Configuring the NetScaler Appliance for Web Server Logging Buffer Size Modifying the Default Buffer SizeParameter for modifying the buffer size Sh weblogparam Example Supported Platforms for the Nswl Client Operating system To modify the buffer size by using the configuration utility Cp pathtocd/Utilities/weblog/Solaris/NSweblog.tar /tmp Installing Nswl Client on a Solaris Operating SystemHardware requirements Pkginfo grep NSweblog Installing Nswl Client on a Linux Operating SystemCd /tmp Tar xvf NSweblog.tar To 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 System Rpm -i NSweblog.rpm Installing Nswl Client on an AIX Operating SystemTo uninstall the Nswl client on a Windows system Cp pathtocd/Utilities/weblog/AIX/NSweblog.rpm /tmp Nswl Command Options Nswl command Specifies Nswl Client Command Options Nswl -addns -f directorypath \log.conf Adding the IP Addresses of the NetScaler ApplianceTo add the Nsip address of the NetScaler appliance Customizing Logging on the Nswl Client System Verifying the Nswl Configuration FileTo verify the configuration in the Nswl configuration file Running the Nswl Client 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 Directive Descriptions EntriesDirectives Examples FieldsIdentifiers Prefix Descriptions Specifies Description W3C Extended Log Format Identifiers No Prefix Required Field 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 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 Show ntp server Example Configuring Clock SynchronizationTo add an NTP server by using the NetScaler command line Maxpoll Parameters for configuring an NTP serverServerName Minpoll Starting 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 Acknowledgment To enable Sack by using the Configuration Utility Clearing the Configuration Level Parameters for clearing a configurationTo clear a configuration by using the configuration utility Viewing the Http Band Statistics RespBandSize ReqBandSize Built-in Http Profiles Built-in profile Description Configuring Http ProfilesTo modify the band range by using the configuration utility To add an Http profile by using the NetScaler command line Parameters 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 profile Mss 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 Works Installing the Web Interface JRE tar file path Configuring the Web InterfaceWeb Interface tar file path Parameters for configuring Web interface sites Port Gateway Direct ModeAuthentication Point Access Gateway URL Transport Configuring a Web Interface Site for LAN Users Using HttpXML Service Addresses XML Service Port 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 Specifying a Collector Enabling or Disabling the AppFlow FeatureTo specify a collector by using the NetScaler command line Parameters for specifying a collector Configuring an AppFlow ActionTo remove a collector by using the NetScaler command line To specify a collector by using the configuration utility Comment Parameters for configuring an AppFlow actionCollectors 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 LabelName Parameters for binding an AppFlow policyGotoPriorityExpression Invoke Invoke flag LabelType Click Apply Changes Enabling AppFlow for Virtual Servers Setting the AppFlow Parameters Enabling AppFlow for a Service AppFlow Parameters HttpHost HttpCookieHttpReferer HttpMethod Reporting Tool Working with Reports Using the Reporting ToolTo invoke the Reporting tool 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 Modifying a Chart Working with ChartsAdding 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 Examples Deleting a ChartTo export chart data to Excel Limits on Entity Numbers Retrieved by nscollect Entity name Stopping and Starting the Data Collection Utility Netscaler/nscollect stop To stop nscollectTo start nscollect on the local system Entity name Limit Netscaler/nscollect start To start nscollect on the remote system