Back to Home | Help Center | Log Out
 Help Center
 
Help Center

Home

Crawl and Index

Serving

Status and Reports

Connector Administration

Social Connect

Cloud Connect

GSA Unification

GSAn

Administration
  System Settings
  Network Settings
  User Accounts
  Login Terms
  Change Password
  SNMP Configuration
  Certificate Authorities
  DNS Override
  SSL Settings
  LDAP Setup
  License
  Import/Export
  Reset Index
  Shutdown
  Remote Support
  Support Scripts

More Information

Administration > SNMP Configuration

Use the Administration > SNMP Configuration page to enable SNMP (Simple Network Management Protocol) so that you can receive messages when the operational state of the Google Search Appliance changes.

Note: Only configure this feature if you already use SNMP to manage other devices in your network such as routers, switches, application servers, or storage servers.

Before Starting this Task

Before configuring SNMP, complete the tasks shown in the following table.

Task Description
Obtain MIB files from Google Enterprise support The following table lists the Management Information Base (MIB) files for the Google Search Appliance.

MIB File Description
GOOGLE-MIB.txt Provides the starting google.gsa. object path that precedes the objects in the GSA-MIB, and identifies Google MIB contact information.
GSA-MIB.txt Defines search appliance variables. A complete list is defined in SNMP Objects.
Obtain a SNMP management application Obtain a third-party SNMP management application, such as, HP OpenView, Getif (Windows). You need to provide the management application with the search appliance's MIB files. Refer to the management application's instructions about how to work with MIB files.

The following tasks are discussed in this document:

Understanding SNMP

SNMP is an Internet standard protocol that monitors the operation of devices on a network. A network device, such as a router, server or the search appliance responds to queries about its state that are initiated by an SNMP management application. A device may also initiate sending a message called a trap (in SNMP v1) or a notification in SNMP v2 or v3, to inform the management application of a significant event. The search appliance listens for SNMP requests on UDP port 161.

The MIB files describe the objects or characteristics that the search appliance exposes through SNMP. The managed objects described in the MIB include configuration parameters and performance statistics.

The SNMP server on the Google Search Appliance provides a subset of the status information about the search appliance that is available in the Admin Console. This status information can be monitored using any third-party SNMP management application.

The search appliance supports SNMP Get and GetNext commands. Currently, it does not support Trap, nor setting values through SNMP Set.

Page Options

The SNMP configuration page contains the options shown in the following table.

Item Description
Enable SNMP Support Enable to receive messages when search appliance events change.
    Enable SNMP Support Click the check box to enable SNMP.
    Enable/Disable SNMP button Displays additional options for configuring SNMP.
SNMP System Information Enables you to enter descriptive information about the system.
    SysName By convention, this is the fully-qualified domain name.
    SysLocation The physical location of this node, for example, "telephone closet, 3rd floor."
    SysContact The textual identification of the contact person for this managed node, for example, "appliance-admin@somecompany.com."
SNMP v1/v2 Configuration Enables you to specify a SNMP v1 or v2 community string. You can share the community string among those who need to view the search appliance values that the MIB provides.
     Communities allowed access A unique name of up to 32 alphanumeric characters. The dash (-) and underscore (_) characters are allowed, but not any other special characters or a space. Because this string is shared between communities, the value should not be easily guessed.
     Save Communities button Click to save the community information.
SNMP v3 Configuration
Add SNMPv3 User 		Enables you to take advantage of the SNMP v3 security features in which MIB object information is encrypted before being sent to an SNMP client application.
     Username Specify an alphanumeric user name (without special characters or an @ sign).
     Authentication Scheme Specify whether or not to use an authentication passphrase to encrypt object data and a privacy passphrase that provides a further level of security for user access to the SNMP information.

Click NoAuthNoPriv to not specify an authentication or privacy passphrase, authNoPriv to specify an authentication passphrase but not a privacy passphrase, or authPriv to specify both passphrases.
     AuthPassPhrase Specify an authentication passphrase, which SNMP uses to encrypt private keys. Only specify this phrase if you set the Authentication Scheme to authNoPriv or authPriv.
     Repeat AuthPassPhrase Repeat the authentication passphrase to ensure that you entered the value correctly.
     Authentication Protocol Click MD5 or SHA. From a security standpoint, the use of MD5 in SNMP is acceptable, but because SNMP uses unkeyed MD5 for hashing passwords into key material, we recommend that MD5 not be used.
     PrivPassPhase Specify a privacy passphrase if you set the Authentication Scheme to authPriv.
     Repeat PrivPassPhase Repeat the privacy passphrase to ensure that you entered the value correctly.
     Add User button Click to save the values you entered for the SNMP v3 Configuration.
Delete SNMPv3 User(s) Enables you to delete previously created SNMP v3 users.
     Currently registered SNMPv3 Users Lists the SNMP v3 users. Click the check box beside the user name to indicate that you want to delete a user.
     Delete User(s) button Click to delete the user you marked for deletion.

Enabling or Disabling SNMP

The following sections describe how to use SNMP on a Google Search Appliance.

Configuring SNMP Support

The search appliance can be configured to enable or disable the SNMP support.

To view or edit SNMP configuration:

  1. Click Administration > SNMP Configuration.
  2. Use the checkbox to enable/disable SNMP support and then click the Enable/Disable SNMP button.
  3. Enter SNMP system information.
  4. Enter the required information in the editable fields. (See the information below for your version.)
  5. Click the submit button corresponding to information edited.

SNMP v1/v2 Configuration

SNMP version 1 and version 2 use community names to authenticate a user before providing system information. To use the SNMP interface of search appliance in version 1/version 2 mode, provide community names in the text field and click the Save Communities button.

To disable access using SNMP v1/v2, leave the text field blank and click the Save Communities button.

SNMP configuration will sync from master node to replica node when in GSA^n configuration. However, you need to click the Save Communities button from the Admin Console on the replica node in order to start the SNMP daemon on the replica node.

Tip: Keep the community names secret to prevent unauthorized access to information about the search appliance.

SNMP v3 Configuration

SNMP version 3 uses a much stronger authentication mechanism for users. It requires setting up user accounts to access SNMP information. User accounts to access SNMP can be added and deleted as described below.

Tip: If your SNMP client can use SNMP v3, it is always preferable over SNMP v1 and SNMP v2.

Add SNMP v3 User

To add an SNMP v3 user, enter a Username, specify the other fields, and click the Add User button. The user name must be letters or numbers only.

Delete SNMP v3 User(s)

To delete users allowed to access SNMP information, check the boxes next to their user names and click the Delete User button.

SNMP Objects

Through SNMP, the search appliance provides a subset of the information that is seen in the Admin Console. The data provided through SNMP is read-only; that is, the search appliance does not support the SNMP Set function.

The MIB files specify all of the data, or "managed objects" that the appliance makes available. Each object has a unique object identifier (OID), which consists of numbers separated by decimal points, a human-readable label, and other parameters. When an SNMP manager wants to know the value of an object, it queries the search appliance using the appropriate OID. The search appliance also supports standard SNMP MIBs.

The following table lists the search appliance MIB contents.

Object (under google.gsa.) Type Description
crawl.crawlRunning Integer, Read-only Crawling activity:
0 = Paused
1 = Running
crawl.status.docsServed Integer32, Read-only The number of documents being served.
crawl.status.crawlingRate Integer32, Read-only The current crawling rate in pages per second.
crawl.status.docBytes Integer32, Read-only The total megabytes processed so far.
crawl.status.todayDocsCrawled Integer32, Read-only The number of documents crawled today.
crawl.status.docErrors Integer32, Read-only Number of times an error occurred while trying to crawl a document.
crawl.status.docsFound Integer32, Read-only Total documents found.
crawl.status.batchCrawlRunning Integer, Read-only 0 = Batch crawl off
1 = Batch crawl on
crawl.status.batchCrawlStartTime Integer32, Read-only Time that the most recent batch crawl started.
crawl.status.batchCrawlEndTime Integer32, Read-only Time that the most recent batch crawl ended.
serving.qpm Integer32, Read-only Serving status in terms of queries per minute handled.
system.gsaDisk.diskHealth Integer, Read-only Disk status:
0 = Green (OK)
1 = Yellow (Warning)
2 = Red (Critical Warning)
system.gsaDisk.diskErrors DisplayString, Read-only Errors associated with disk.
system.temperature.temperatureHealth Integer, Read-only Temperature status:
0 = Green (OK)
1 = Yellow (Warning)
2 = Red (Critical Warning)
system.temperature.temperatureErrors DisplayString, Read-only Error message associated with temperature.
system.machine.machineHealth Integer, Read-only Machine status:
0 = Green (OK)
1 = Yellow (Warning)
2 = Red (Critical Warning)
system.machine.machineErrors DisplayString, Read-only Error message associated with machine.

For More Information

For more information, see the following documents:

 
© Google Inc.