Statseeker Add-ons

What are Statseeker Add-ons?

Statseeker has produced a series of generic scripts based on recent feedback from our customer base. These scripts are currently being added to the product and will be made available in an upcoming release. In the mean time, we have made these scripts available to Customers for immediate deployment onto Version 3.5 sites.

This document describes the functionality of these scripts and how to access these scripts.

Suggestions

If you have a request or suggestion for a new Add-on or product enhancement, please contact our Customer Service Team at csm@statseeker.com.

To Obtain an Add-on:

  1. Let our Customer Service Team know which Add-ons you require by emailing csm@statseeker.com;
  2. Our Customer Service Team will email you a link to the Add-ons.

Index

How to Install Add-ons

Version 3.5 includes a new Manage Scripts section in the Administration Tool, specifically designed to provide customers with a simple method for installing, upgrading and deleting Add-on script packages. Customers should upgrade to Version 3.5 before installing Add-ons.

To add a script:

  1. Download the script (compressed file.tgz) from the link emailed to you;

    2. NOTE: Do not unzip this file.

  2. Copy the file to a local directory on your PC;
  3. Open a browser and log into the Statseeker User Interface as the Administrator (admin);
  4. Go to Administration Tool> Statseeker Custom Services> Manage Scripts;
  5. Select Browse, find the location of the script, and select Open;

  6. Select Upload;

  7. The script will install and display a success notification. The script will also be highlighted Green to alert the Statseeker Administrator to which scripts were installed during the current upload;

    Note: When the first script is installed, two base packages will also be installed, scs_common and scs.

  8. Repeat this process to add more scripts;
  9. Browse to find the next script and select Open;

  10. Select Upload;

    Note: Only the latest installed scripts will be highlighted Green with a success notification.

  11. All of the functional scripts Administrators use contain help documentation. To access the documentation, simply select the ‘DOC’ icon and a new window will appear;

    12. Note: The method above is also used to upgrade scripts. To delete a script, select the delete button on the right hand side.

Add-ons

  1. Auto Grouping (scs_grouping)

    2. This script provides the ability to add entities to groups and make bulk configuration changes to items within these groups. Regular Expressions can be applied to almost any device or interface configuration item to automatically populate groups.

    This list of configuration items include:

    • sysName;
    • sysContact;
    • sysLocation;
    • sysDescr;
    • sysObjectId;
    • ifName;
    • ifIndex;
    • ifDescr;
    • ifAlias;
    • ifType;
    • ifSpeed.

    To use this script:

    1. Telnet or SSH to the Statseeker server;
    2. Log in as the statseeker User, with the same password as the root/admin password;
    3. Run any of the following scs_grouping commands.

    Note: It is highly recommended that the -z option is used to verify what changes will be made to the system before applying any scs-grouping commands. As an example: If a User wanted to add everything in groups "Melbourne-core" and "Melbourne-Edge" to group "Melbourne-All", the command should first be entered as: 

      scs-grouping –g “Melbourne-Core,Melbourne-Edge” –z

    This will print a list on the screen of all the devices that have been filtered with the above command. If the User is satisfied with the output, the following command can be run: 

      scs-grouping -g "Melboune-Core,Melbourne-Edge" -a "Melbourne-All"

    Examples:

    Add all devices that match "Melbourne" in the name to group "Melbourne" but remove all entries from the group first (ie if it doesn't match Melbourne it will no longer be in the group): 

      scs-grouping -d 'name=Melbourne' -r -a "Melbourne"

    Add all devices not in any group to the group "No Group": 

      scs-grouping -N -a "No Group"

    Create a list of devices that have 10G interfaces. The -D flag makes it a device group: 

       scs-grouping -i 'ifSpeed=^10000000000$' -D -a Switches10G

    Alternate method for above: 

      scs-grouping -g 'Interface: Speed  10G' -D -a Switches10G

    Turn polling off for all interfaces in the 'not polled' group: 

      scs-grouping -g 'not polled' -s 'ifPoll=off' -l

    Add all interfaces that match 'Vl' to the group 'virtual' and set ifOperstatus polling to nopoll: 

      scs-grouping -i 'ifName=^Vl\d+$' -a virtual -s 'ifOperStatus=nopoll'

    Append '-core' to all ifTitles that are in the 'core routers' group: 

      scs-grouping -g 'core routers' -I -s 'ifTitle=s/(.*)/$1-core/'

    Remove -core from the ifTitles ending in –core: 

      scs-grouping -g 'core routers' -s 'ifTitle=s/^(.*)-core/$1/'

    Change the snmp community of all devices in group "Site1" to "site1pub": 

      scs-grouping -g 'Site1' -D -s 'community=site1pub'

    See the help documentation provided within the script for the full list of the options available.

  2. Email Alerting (scs_email_alert)

    3. This script provides multiple options for email alerting.

    Functionality of this script includes:

    • The amount of downtime for an outage when an 'up' event is emailed;
    • Customization of the format for both the subject line and the body of the email alert. This could mean striping out information that is not relevant, adding information like a sysContact, sysLocation etc. or limiting the number of fields so that the email format will work with a pager or SMS alerting system;
    • The ability for the action to send messages to multiple email addresses, multiple groups or multiple Users;
    • Sending an email in the morning to let Users know all devices that went up or down overnight;
    • Sending an email in the morning for all devices that went down overnight, and stayed down;
    • Specifying an outage time before an email is triggered;
    • Use of a rostering system allowing Administrators to enter a schedule so on call staff are alerted.

    To use this script:

    1. Log into Statseeker as the Administrator;
    2. Go to Administration Tool> Device Events> Actions/Filters OR, Administration Tool> Interface Events> Actions/Filters;
    3. Under Device Events Actions OR Interface Events Actions, select Add;
    4. Enter an appropriate scs-alert-emailer command into the Command section and continue with the alerting configuration.

    Examples:

    Send a bundled email to multiple addresses when devices are unreachable for 5 minutes: 

      scs-alert-emailer –b 2 –t ‘bundleandwait’ –w 5 –e njc@statseeker.com,training@statseeker.com

    Send the same email but with a customized subject line and message body: 

      scs-alert-emailer –b 2 –t ‘bundleandwait’ –w 5 -s "Devices Down for 5mins (%Cd) Up (%Cu)" -B "%d %n %i %e %D" –e njc@statseeker.com,training@statseeker.com

    See the help documentation provided within the script for the full list of the options available.

  3. Email Report Scheduler (scs_scheduled_email)

    4. This script automates the scheduling and emailing of reports.

    Functionality of this script includes:

    • Emailing of any report or reports in Statseeker with a unique URL;
    • The ability to describe the purpose of the report in the message body of the email so non-Statseeker Users understand the content;
    • Emailing one or many email addresses;
    • Emailing one or many Statseeker Users;
    • Emailing one or many Groups of Statseeker Users;
    • Scheduling emails to be sent hourly/weekly/monthly/quarterly etc.

    Note: this script will not convert the reports to PDF or HTML. This is on our enhancement list.

    See the help documentation provided within the script for the full list of the options available.

  4. Bulk Addition of Ping Only Devices (scs_bulkpingadd)

    5. This script uses a Host File to load devices into a configuration as ‘ping only’ devices. This provides the ability to:

    • Monitor availability of multiple IP addresses on a single device;
    • Quickly add ping only devices without running discoveries;
    • Bypass the duplicate checking process that normally stops the adding of IP addresses already identified on other configured devices.

    To use this script:

    1. Go to Administration Tool> Statseeker Custom Services> Manage Scripts;
    2. Select the ‘Configure Script’ icon on the right hand side. A window will appear that allows Users to add a host file of ping only devices;
    3. Add Hosts;
    4. Select ‘Save’.

    See the help documentation provided within the script for the full list of the options available.

  5. Bulk Device Deleter (scs_bulkdelete)

    6. This script bulk deletes devices via the Statseeker Command Line Interface. It also works in conjunction with the scs_grouping script to enable the bulk deletion of every device in a group, or every device that matches a regular expression across any of the grouping fields.

    For example, delete every device that contains the text ‘UPS’ in the ‘sysDescr’.

    See the help documentation provided within the script for the full list of the options available.

  6. Upstream Devices (scs_upstream_devices)

    7. When a device goes down, the devices behind or downstream from that device will also be seen as unreachable by Statseeker. This makes it difficult to identify the actual faulty device, as multiple email alerts will be generated for all downstream devices connected to the faulty device.

    This script asks the User to identify the upstream devices for each device or group of devices, so that email alerts are only sent for the 'root cause' of the problem.

    See the help documentation provided within the script for the full list of the options available.

  7. CSV Data Output (scs_csv_export)

    8. This script exports timeseries data for a group of interfaces.

    This is similar to the "Export" option from the Advanced Interface Reporting Tool.

    This script provides the additional option of exporting the data in columns instead of rows.

    The interfaces to export are specified via a group. These can be further limited via a filter in the same style as the scs-grouping script.

    Examples:

    To export to stdout, the last 24 hours of utilization data, on all Interfaces in the group 'Primary WAN Links' that contain Gi1 in their ifName: 

      scs-export -g ‘Primary WAN Links’ -i 'ifName=Gi1' -t "range = now - 1d to now"

    To export to a file 'output.csv', today's Bytes data for all of the interfaces in the group 'Uplinks' in columns, instead of rows (default): 

      scs-export -g ‘Uplinks’ -t Today -r Bytes -v -o output.csv

    See the help documentation provided within the script for the full list of the options available.

  8. SNMP Failing Alert (scs_snmp_alert)

    9. This script creates an alert when snmp polling fails for a device. NOTE: It does NOT create an event or keep any history.

    An Action can be passed as a parameter, otherwise the output will go to stdout which is suitable for piping into an alert-emailing script.

    Output format is: 

      event_time,0,ega_id,ega_name,snmp_state (up|down)

    Examples:

    Use action "Email Me": 

      scs-snmp-alert "Email Me"

    Pipe stdout into scs-alert-emailer: 

      scs-snmp-alert | scs-alert-emailer -e njc@statseeker.com

    See the help documentation provided within the script for the full list of the options available.

© 1998-2012 Statseeker Pty Ltd. All rights reserved.