Getting Started
Quick start

Quick start

To start your monitoring project, you will need access to a ServicePilot server. There are two ways of deploying ServicePilot:

Software as a Service: Cloud-based ServicePilot Web interface managed by ServicePilot Technologies that customers will connect to via the Internet. Only an Agent needs to be installed to start monitoring.
On Premise: Customers install the ServicePilot software On-premise. Customers manage their own deployment and data.

ServicePilot SaaS platform

ServicePilot Agent for Cloud

To use the ServicePilot SaaS platform, 3 steps are essential to get started:

Create a ServicePilot account - to log in to the ServicePilot web pages.
Install a ServicePilot Agent - to collect data (downloadable from the ServicePilot web interface).
Start monitoring equipment - by adding provisioning rules and resources to monitor your environment.

ServicePilot On-Premise deployment

ServicePilot Agent for On-Premise

ServicePilot On Premise only requires a few steps to get started:

Obtain the ServicePilot installer - by contacting ServicePilot Technologies to get the software: Support ([email protected]).
Install ServicePilot - by following the installation guide.
Obtain a ServicePilot license - by contacting ServicePilot Technologies to get a trial license.
Start monitoring equipment - by adding provisioning rules and resources to monitor your environment.

Set up a ServicePilot account

Before being able to access ServicePilot web pages, a customer account will be required. Go to the ServicePilot SaaS Login page and use the Sign up link to create an account.

Once you have your login Username and Password you can use these to open your ServicePilot web pages.

To manage your account and create other users and groups, see the Users documentation.

Install a ServicePilot Agent

There are a number of different ServicePilot Agents. Choose the ServicePilot Agent you require. Download and install the Agent from the ServicePilot web pages.

Using a user with administrative privileges, log in to ServicePilot.
Click on SETUP > Agents > Install an agent.
Select the Agent to install and follow the instructions under Get started.

ServicePilot Agents are explained in more detail in the Agents documentation.

Start monitoring equipment

A ServicePilot Agent may be able to collect data but ServicePilot still needs to be told what each Agent should do. There are two main ways in which equipment may be added to the configuration:

Rules to provision resources automatically when equipment is discovered.
Adding resource configuration manually.

The provisioning required will depend on the type of resource monitored. See Packages documentation for details when adding a resource manually.

ServicePilot provisioning is explained in more detail in the Data collection documentation.

Add an Auto-provisioning rule

It is also possible to automatically monitor resources when new Agents are deployed. Set up auto-provisioning rules to tell ServicePilot what package to use when adding a new Agent and where to place the resource in the monitoring hierarchy.

Using a user with administrative privileges, log in to ServicePilot.
Open SETUP > Parameter.
Click on Auto-provisioning.
Click on Add a rule.
Complete the Automatic provisioning rule dialog. Specify at least a Rule name and set the Discovery type based on the Agent installed.
Click on OK.
Finally, click on Save.

See Auto-provisioning for more details.

Add a manual resource

To monitor a device, pick one of the pre-configured packages and add it to the configuration by answering a few questions. These normally include the device IP address, which ServicePilot Agent to use to query this device and what sort of supervision is required.

Using a user with administrative privileges, log in to ServicePilot.
Open SETUP > Provisioning.
Select the type of monitoring package needed by category and use the filter to limit the options displayed.
Drag and drop a package into the central view editor.
Set the resource properties based on the package type selected. A unique resource name is always required as well as all fields highlighted with a *.
To view package documentation, click on the Documentation tab.
Click OK.
Finally, click on Save.

Note: many packages use SNMP queries to obtain information. You may need to specify a SNMP policy with the correct credentials to monitor the device. See the Policies documentation for details.

See Add a manual resource for more details.

Setup

Settings menu

As an administrative user of ServicePilot, configuration may be changed under the Setup menu items. Start with Users, Agents, Data collection and Policies documentations for more details.

Menu item	Data display
Provisioning	Modify resources to be monitored using the View editor, of via the Resources list. Packages and How to documentation is provided to automate provisioning and provide data to ServicePilot.
Agents	View, install and manage ServicePilot Agents.
Parameters	Landing page for ServicePilot Administration and settings.