Configuration and Discovery

Download this manual as a PDF file

The following sections describe how to configure SoftLayer resources for monitoring by SL1 using the SoftLayer: Cloud PowerPack:

Copying Your SoftLayer API Key

Before you can monitor your SoftLayer account in SL1, you must first generate or retrieve the user-specific API key for your SoftLayer account. SL1 requires this unique API key to communicate with your SoftLayer account.

To generate your SoftLayer API key:

  1. Log in to the SoftLayer customer portal and go to the Users page (Account > Users).

  1. Click the Generate link in the API Key column for your SoftLayer user. The Generate link changes to a Show link.
  2. Click the Show link. Your API key appears.
  3. Copy the API key.

To retrieve your SoftLayer API key:

  1. Log in to the SoftLayer customer portal.
  2. Click your username on the Navigation Pane. The Edit User Profile page appears.
  3. Locate and copy the API Key.

Configuring a Basic/Snippet Credential for SoftLayer

To configure SL1 to monitor a SoftLayer account, you must create a Basic/Snippet credential. This credential allows the Dynamic Applications in the SoftLayer: Cloud PowerPack to communicate with your SoftLayer account.

An example Basic/Snippet credential that you can edit for your own use is included in the SoftLayer: Cloud PowerPack.

To configure a Basic/Snippet credential to access your SoftLayer account:

  1. Go to the Credential Management page (System > Manage > Credentials).

  1. Locate the SoftLayer Credential and click its wrench icon (). The Edit Basic/Snippet Credential page appears.

  1. Complete the following fields:
  • Credential Name. Type a new name for the SoftLayer credential.

  • Hostname/IP. Type a value, such as "%D".

The credential requires a value in the Hostname/IP field, but the value itself does not matter.

  1. Click the Save As button.

Creating a SoftLayer Virtual Device

Because the SoftLayer service does not have an IP address, you cannot discover a SoftLayer device using discovery. Instead, you must create a virtual device that represents the root device for the SoftLayer service. A virtual device is a user-defined container that represents a device or service that cannot be discovered by SL1. You can use the virtual device to store information gathered by policies or Dynamic Applications.

If you have multiple SoftLayer subscriptions you want to monitor, you should create a separate virtual root device for each.

To create a virtual device that represents your SoftLayer service:

  1. Go to the Device Manager page (Devices > Classic Devices, or Registry > Devices > Device Manager in the classic SL1 user interface).
  2. Click the Actions button and select Create Virtual Device from the menu. The Virtual Device modal page appears.

  1. Enter values in the following fields:
  • Device Name. Enter a name for the device. For example, you could enter "SoftLayer Service" in this field.

  • Organization. Select the organization for this device. The organization you associate with the device limits the users that will be able to view and edit the device. Typically, only members of the organization will be able to view and edit the device.
  • Device Class. Select Service | SoftLayer Service.
  • Collector. Select the collector group that will monitor the device.
  1. Click the Add button to create the virtual device.

Aligning the SoftLayer Dynamic Applications

There are three types of Dynamic Applications included in the SoftLayer: Cloud PowerPack:

  • Discovery. These Dynamic Applications poll SoftLayer for new instances of services or changes to existing instances of services.

  • Configuration. These Dynamic Applications retrieve configuration information about each service instance and retrieve any changes to that configuration information.
  • Performance. These Dynamic Applications poll SoftLayer for performance metrics.

To discover all of the components of your SoftLayer account, you must manually align the "SoftLayer: Account Discovery" Dynamic Application with the SoftLayer virtual device.

When you align the "SoftLayer: Account Discovery" Dynamic Application with the SoftLayer virtual device, the Dynamic Application creates a component device representing the SoftLayer account. Under the SoftLayer account component device, SL1 automatically aligns additional Dynamic Applications that:

  • Discover and create child component devices for each region used by the SoftLayer account

  • Discover and create child component devices for the SoftLayer CDN service and any CDN accounts associated with the SoftLayer account
  • Retrieve SoftLayer account invoice information

Under each region, SL1 then discovers "bucket" component devices that act as parents for each of the following component devices, which SL1 also discovers:

  • Virtual Servers
  • Bare Metal Servers

  • Network Services
  • Private Networks
  • Subnets
  • VLANs

  • Public Networks
  • Subnets
  • VLANs
  • Local Load Balancers

To align the "SoftLayer: Account Discovery" Dynamic Application to your SoftLayer virtual device, perform the following steps:

  1. Go to the Device Manager page (Devices > Classic Devices, or Registry > Devices > Device Manager in the classic SL1 user interface).

  1. Click the wrench icon () for your SoftLayer virtual device.
  2. In the Device Administration panel, click the Collections tab. The Dynamic Application Collections page appears.
  3. Click the Action button and select Add Dynamic Application from the menu.

  1. In the Dynamic Application Alignment modal page:

  1. Click the Save button to align the Dynamic Application with the SoftLayer virtual device.

Viewing SoftLayer Component Devices

When SL1 performs collection for the SoftLayer virtual device, SL1 will create component devices that represent each region in your SoftLayer service and align other Dynamic Applications to those component devices. Some of the Dynamic Applications aligned to the component devices will also be used to create additional component devices. All component devices appear in the Device Manager page just like devices discovered using the ScienceLogic discovery process.

In addition to the Device Manager page, you can view the SoftLayer service and all associated component devices in the following places in the user interface:

  • The Device View modal page (click the bar-graph icon []for a device, then click the Topology tab) displays a map of a particular device and all of the devices with which it has parent-child relationships. Double-clicking any of the devices listed reloads the page to make the selected device the primary device.

  • The Device Components page (Registry > Devices > Device Components) displays a list of all root devices and component devices discovered by SL1 in an indented view, so you can easily view the hierarchy and relationships between child devices, parent devices, and root devices. To view the component devices associated with a SoftLayer service, find the SoftLayer virtual device and click its plus icon (+).

  • The Component Map page (Classic Maps > Device Maps > Components) allows you to view devices by root node and view the relationships between root nodes, parent components, and child components in a map. This makes it easy to visualize and manage root nodes and their components. SL1 automatically updates the Component Map as new component devices are discovered. The platform also updates each map with the latest status and event information. To view the map for a SoftLayer service, go to the Component Map page and select the map from the list in the left NavBar. To learn more about the Component Map page, see the section on Views.

Adding Collection Objects to the SoftLayer Dynamic Applications

If you want SL1 to collect information about your SoftLayer account that is not already collected by the Dynamic Applications in the SoftLayer: Cloud PowerPack, you can add a Collection Object to the appropriate Dynamic Application to enable SL1 to do so.

The following SoftLayer reference documents describe the possible properties that can be collected:

To add a SoftLayer property as a collection object, you must translate the property hierarchy to a string. To format the property hierarchy as a string, separate each group in the hierarchy with a dash character followed by a dash and the property name. For example, the property for hard drive capacity (named "capacity") on a bare metal server is under the hardDrives group, then the hardwareComponentModel group. The string format for this hierarchy is:

hardDrives-hardwareComponentModel-capacity

 

To add a Collection Object to a SoftLayer Dynamic Application:

  1. Go to the Dynamic Applications Manager page (System > Manage > Applications).

  1. Find the Dynamic Application to which you want to add a collection object, then click its wrench icon (). The Dynamic Applications Properties Editor page appears. You can add collection objects to the following Dynamic Applications:
  • SoftLayer: Bare Metal Server Configuration

  • SoftLayer: Bare Metal Server Private Network Performance
  • SoftLayer: Bare Metal Server Public Network Performance
  • SoftLayer: Virtual Server Configuration
  • SoftLayer: Virtual Server CPU Performance
  • SoftLayer: Virtual Server Memory Performance
  • SoftLayer: Virtual Server Private Network Performance
  • SoftLayer: Virtual Server Public Network Performance
  • SoftLayer: Load Balancer Configuration
  1. Click the Collections tab. The Dynamic Applications | Collections Objects page appears.
  2. Enter values in the fields on this page. Enter the string that represents the property hierarchy in the Snippet Arguments field. For information about the other fields in this page, see the see the section on Collection Objects.
  3. Click the Save button to save the collection object.
  4. If you added a collection object to a performance Dynamic Application, a presentation object is automatically created for the collection object. If you want to edit the presentation object, click the Presentations tab and click the wrench icon () for the presentation object.
  5. If you added a collection object for a property that is in a group from which no other properties are collected, you must repeat steps 1 - 6 to add the unique ID of that group as a collection object.