This
The following video provides an overview of the SL1 user interface:
Use the following menu options to navigate the SL1 user interface:
- To view a pop-out list of menu options, click the menu icon (
). - To view a page containing all the menu options, click the Advanced menu icon (
).
This
Logging In and Out of the SL1 User Interface
This topic covers how to access the different user interfaces for SL1: the "new" SL1 user interface and the "classic" user interface.
Starting with SL1 version 11.1.0, the SL1 user interface is the default user interface, not the classic.
If your 11.1.0 or later SL1 system was installed using an ISO, the SL1 user interface is set as the default, but if your SL1 system was upgraded with a patch, the classic user interface will still be set as the default user interface. To change the default user interface (UI), edit the New UI Default option on to the Behavior Settings page (System > Settings > Behavior).
The SL1 User Interface
Starting with SL1 version 11.1.0, you no longer need to type /ap2 at the end of the URL or IP address, such as https://sl1.sciencelogic.com/ap2, to get to the SL1 user interface. The /ap2 is added to the IP address by default.
To log in to the SL1 user interface:
-
In a browser, type the URL or IP address for your SL1 system. The login page for SL1 appears:
-
Type the current user name and password you use with SL1 and click Log In. The SL1 login button displays a spinning status icon while you are being logged in.
-
If your company uses Single Sign-On (SSO) for authentication, you will be redirected to your company's SSO page, where you can log in to SL1 with your SSO credentials. When you log out, the logout screen redirects you to an SSO page instead of the typical login screen.
-
If you are logging in for the first time, you will be prompted to change your password. Type your username, your old password, and type your new password twice in the New Password and Confirm Password fields. Click .
-
If your SL1 system is a Military Unique Deployment (MUD) system, a Disclaimer modal appears, and you will need to click after reading the text to use SL1.
-
For an Administrator user, the End User License Agreement (EULA) appears the first time the Administrator user logs in to SL1. The user must agree to the terms before using SL1.
If you can still see the horizontal NavBar or other features of the classic user interface in the SL1 user interface, click in your browser.
A number of classic user interface pages exist within a frame in the new SL1 user interface, and these pages have the same appearance and functionality in both user interfaces. These pages will eventually be integrated into the SL1 user interface, and the corresponding GraphQL APIs for those feature are not yet available. If you navigated to a classic (framed) page in the SL1 user interface by typing /em7 in the URL to go to the classic user interface, the top navigation might be missing from the classic user interface. To address this issue, navigate back to the new user interface, log out, and then log in to the classic user interface.
To log out of the SL1 user interface:
- Click your user name in the navigation bar at the top of any SL1 page.
- Click Log off. You are logged out, and a logoff page appears with the option to log in again.
The Classic User Interface
To log in to the classic user interface for SL1:
-
In a browser, type the URL or IP address for your SL1 system, followed by /em7. The login page for the classic user interface appears.
-
Type the current user name and password you use with SL1 and click Log In.
You can log out of the classic user interface by typing /em7/logout.em7 at the end of the URL or IP address.
-
To switch to the SL1 user interface while you are using the classic user interface, type / at the end of the URL or IP address for your SL1 system and press . The login page of the SL1 user interface appears.
-
To switch to the classic user interface while you are using the SL1 user interface, type /em7 at the end of the URL or IP address for your SL1 system and press . The login page for the classic user interface appears.
-
To make the classic user interface the default interface, go to the Behavior Settings page (System > Settings > Behavior) and unselect the New UI Default option.
If you need to run both the classic and SL1 user interfaces simultaneously, you can open the classic and the SL1 version in two different browsers, or you can open private or incognito browser windows and then log in to the two user interfaces.
Using the Navigation Menus
Starting with the 8.12.0 release of SL1, the SL1 user interface was upgraded to include content from both the "new" user interface (also called "ap2") and the "classic" user interface. This "unified" user interface provides a more streamlined method of navigation that uses two menus: a basic menu and an Advanced menu.
Use the following menu options to navigate the SL1 user interface:
- To view a pop-out list of menu options, click the menu icon () at the top left of any SL1 page. Use the up and down arrow buttons (
) to expand and contract the menu options. - To view the Advanced Menu page, which contains links to all of the menu options, click the Advanced menu icon () at the bottom left of any SL1 page. Use + in your browser to quickly find a page.
If you are familiar with the classic user interface, the Advanced Menu page will help you get used to the structure of the SL1 user interface.
The name of the SL1 page appears in the title bar of your browser, and the page title also appears in your browsing history to help you navigate through the pages you have visited.
Filtering Inventory Pages
In SL1, an inventory page is any page (or tab) that contains a table with a list of items that you work with, like the Events page or the Devices page. At the top of most inventory pages in the SL1 user interface are a set of filters for the columns in the table on that page.
On an inventory page, you can start typing filter text or select filter options in one or more of these filters to narrow down the items in the list to just the items you want to view.
In the following image, the user is filtering the Devices inventory page by typing part of an IP address in the filter for the IP Address column:
As you type text in the Filter field at the top of a column, SL1 starts to filter the list to include only those elements that include your search terms.
Some filters, like the State filter, let you click a drop-down arrow to select search options from a drop-down menu. Also, any filters related to date and time let you click a calendar icon (
) to select a date or a date range, and a clock icon (
), where relevant, to select a time or a time range.
If you were using a version of SL1 from before version 11.2.0, any list and column preferences you had configured will not be retained with the new features for inventory pages after you upgrade to 11.2.0 or later. This includes customizations such as which columns are visible, column widths, column order, and other customizations.
SL1 retains your search filters on pages in the SL1 user interface even after you refresh the browser or navigate to another page and then return to the page where you created your search.
For more information, see
Using Basic Search
At the top of most lists in the SL1 user interface, the Search field lets you look for specific elements in that list. The Search field contains a magnifying glass icon (
) next to the words "Type to search" or "Search".
As you type text in the Search field, SL1 filters the list to include only those elements that include your search terms. When searching, SL1 considers all relevant columns for the search, including those that are not currently displayed on the page.
SL1 retains your search criteria on pages in the SL1 user interface even after you refresh the browser or navigate to another page and then return to the search page using the button in the browser.
After you type search commands in the Search field, you can click the gear icon (
) and select Advanced to "translate" your basic search into an Advanced Search. For more information, see Performing an Advanced Search.
To use the Search field:
-
Click the Search field and start typing search text. As you type, SL1 provides potential matching values in a drop-down menu and starts filtering the list with your search text.
For example, if you start searching for "database" by typing data, a drop-down list appears with a list of columns that might contain that word, and the list is filtered by items that have "data" in one of their fields.
-
If you select one of the suggested search criteria from the list, such as message, a criteria button displays under the Search field. You can click the criteria button and edit the search text under the button, if needed:
If you select the ANY option from the drop-down menu, the search looks through all relevant columns for matches to your search text. SL1 uses different search criteria for an "ANY" search, depending on the page you are currently on in SL1. For more information, see Fields Used by an "ANY" Basic Search.
If you are unable to paste a copied string of text in the Search field, make sure that your copied text does not contain any hidden special characters.
- To edit the search criteria for your current search even further, click the criteria button and click the contains field. You can choose from additional search operators in the drop-down that appears, such as begins with, is null, equal to, and not equal to.
-
You can add another set of search criteria to an existing search by typing additional text in the Search field, and then selecting additional fields from the drop-down list. The new search terms are added to a second criteria button:
The search criteria button under the Search field also displays the search operator and value for the search as hovertext.
-
Alternately, you can click the menu icon (
) to the right of the Search field to open a menu containing related search criteria. Select an element from the list of criteria and type additional search information in the criteria button that appears under the Search field:
If you select a date-related search criteria from the list of criteria, you can use a drop-down calendar to select a specific date and time.
- To remove a search criteria, click the close icon (
) on the criteria button under the Search field.
- To switch to an Advanced Search, click the gear icon () to the right of the Search field and select Advanced. For more information, see Advanced Search.
- To quickly clear a search, click the gear icon () to the right of the Search field and select Clear.
- To save a search so you can use it again, see Saving a Basic Search.
Fields Used by an "ANY" Basic Search
If you type search criteria into a Search field at the top of a page in SL1 and then select the ANY option from the drop-down menu, the search looks through all relevant columns for matches to your search text.
SL1 uses different search criteria for an "ANY" search, depending on the page you are currently on in SL1. For example, an "ANY" search on the Dashboards page searches for the search criteria in the Dashboard ID or Dashboard Name fields, while an "ANY" search on the Devices page searches for the search criteria in the Device Name, Hostname, Device Class, Collector Group, Organization, and additional fields. See the table below for details.
To see which fields SL1 is using for a search, click the gear icon () to the right of the Search field and select Advanced. The syntax of the Basic Search is converted into an Advanced Search, which lists the relevant fields being searched by SL1.
The following table lists the fields that are used by an "ANY" search, based on the page you are on in SL1:
| Page in SL1 user interface | Fields searched by SL1 for that page |
|---|---|
| Main Pages | |
| Dashboards | Dashboard ID, Dashboard Name |
| Events | Event Message, Aligned Resource Name, Aligned Organization, Aligned Sub-entity Name, Device Name, Hostname, Device Class Logical Name, Device Class Description, Device Collector Group, Device Class, Device Group ID, Device Group Name, Device Class Category |
| Devices, Machine Learning, Device Services | Device Name, Hostname, Device Class Logical Name, Device Class Description, Device Class, Device Group, Device Class Category Name, Collector Group ID, Collector Group Name, Aligned Organization, Machine Learning Policy |
| Business Services and IT Services | Service Type, Service ID, Service Name, Service Label, Service Policy Name, Aligned Organization |
| Maps | Map Name, Map Description |
| Secondary Pages | |
| Agents | Agent Nickname, Agent Operating System, Hostname |
| Business Service Templates | Business Service Template Name, Business Service Template Descriptions |
| Credentials | Credential Name |
| Custom Attributes | Custom Attribute Label, Custom Attribute Name |
| Device Categories | Device Category Name |
| Device Classes | Device Class Name, Device Class Description, Virtual Type, Logical Name, Device Category Name |
| Discovery Sessions | Discovery Session Name, Aligned Collector Name, Aligned Organization |
| Event Policies | Event Policy Name |
| Subscription Usage (Current License Usage) | License Type, Device Name, Aligned Organization, Device Class Category Name |
If a page from the SL1 user interface is not listed in the above table, then SL1 only uses the relevant Name field on that page for an "ANY" search.
Saving a Search
If you are creating a complicated search using Basic Search or Advanced Search, or if you have a search that you use on a regular basis, you can save that search criteria so you can quickly use it again later.
To save a search:
-
After you have created a Basic or Advanced Search, click the gear icon (
) to the right of the Search field and select Save. A Save Search window appears. -
In the Search Name field, type the name of your search and click . The search is added to the list of saved searches.
To use a saved search:
-
Click the gear icon (
) to the right of the Search field and select Saved Searches. An Apply Search window appears. -
From the Select a search drop-down, select the search you want to use and click . That search is applied to the current list.
By default, saved searches apply only to your user profile, and they are not shared with other users.
To share a saved search:
-
Create a Basic Search and change it to an Advanced Search by clicking the gear icon (
) to the right of the Search field and selecting Advanced. -
Copy the Advanced Search code from the Search field and paste it into the relevant documentation so you can share the search with other users.
Performing an Advanced Search
The SL1 user interface includes an Advanced Search option that lets you use customized search commands to search for data. The syntax for these Advanced Searches can be much more complex than a Basic Search, enabling you to find exactly what you need from a list of items.
Also, because the Basic Search only uses "AND" for multiple search criteria, you need to use an Advanced Search for an "OR" search using multiple search criteria, or if you want to create more complicated searches using Boolean Algebra.
At a minimum, an Advanced Search requires the following components, in the following order:
- A field. The general type of data for which you are searching, such as a device name or an event message.
- An operator. A word or symbol that specifies the relationship between the field and the value, such as equals or less than.
-
A value. A specific aspect or version of the field, such as a name or an amount. If a value is a string, it should be surrounded by "quotation marks" or 'apostrophes'.
As you type your Advanced Search, a red icon (
) or a green icon (
) appears at the end of the text field to show that your search is incorrectly or correctly formatted.
To view a list of all possible search commands in an Advanced Search, press + .
The Advanced Search fields and values vary based on the page you are on in the SL1 user interface. For more information about fields, operators, and values, see Components of an Advanced Search.
Below are simple examples of Advanced Search syntax:
message contains 'risk is high'
organization has (company contains 'system')
attribute has (id = year and value = 2021)
name contains 'web_tier' and deviceClass has (description contains 'AppDynamics')
deviceClass has (description contains 'em7 admin portal')
For additional examples, including examples with more complex syntax, see Examples of Advanced Searches.
You can type search commands in the Search field for a Basic Search, and then click the gear icon () and select Advanced to "translate" your basic search into an Advanced Search. You cannot go from an Advanced Search back to a Basic Search, however, without losing your search criteria.
To create an Advanced Search:
- Click the gear icon () to the right of the Search field and select Advanced. The search type changes from Basic to Advanced (note the change in font style).
-
Start typing a field name for your search. As you type, SL1 displays a list of available fields in a drop-down menu:
-
Select or type a field name.
-
To view a list of all possible search commands at any point in an Advanced Search, press . For example, the following operator options appear if you press after typing "message" and inserting a space:
-
Select or type an operator name. If you are typing, SL1 provides a list of available options.
As you type your search command, a red icon (
) appears at the end of the text field if your command is incorrectly formatted or incomplete. Click the red icon to view additional details.
-
Type a value to complete your search, and type additional search commands as needed. When your search is complete and formatted correctly, a green icon (
) appears at the end of the text field:
-
Click the button. The results of your search appear.
Even if you have correct search syntax, SL1 will save your search query only after you click . For example, some pages, such as a Device Service search, might not show all of the search results until you click .
- To clear a search, click the gear icon () to the right of the Search field and select Clear.
- You can save an Advanced Search to use later. By default, saved searches apply only to your user profile, and they are not shared with other users. For more information, see Saving a Search.
Components of an Advanced Search
At the minimum, an Advanced Search requires the following components, in the following order:
- A field. The general type of data for which you are searching, such as a device name or event message.
- An operator. A word or symbol that specifies the relationship between the field and the value, such as equals or less than.
- A value. A specific aspect or version of the field, such as a name or an amount. You must use either "quotation marks" or 'apostrophes' for your search strings, and strings are not case-sensitive.
You can also include the operators "and" or "or" to your search command. Basic Search in SL1 uses only "AND" searches, unless you specify "Any" in your Basic Search.
When SL1 evaluates an Advanced Search command, it evaluates the "OR" expressions first, followed by the "AND" filters.
For example, the following search command looks for events that have a status of Critical and contain a message with the word "error":
status = critical and message contains 'error'
The following search command looks for devices with a name of "device-name" or messages containing the word "error":
name = "device-name" or message contains "error"
You can use parentheses ( ) to group expressions and to ensure that the expressions are evaluated in the correct order. The following search command looks for either devices with a name of "device-name" and a status of Critical, or devices with a name of "device-name" and a status of Major:
(name = "device-name" and status = critical) or (name = "device-name" and status = Major)
Searches in SL1 are not case-sensitive, so you can use any combination of upper-case and lower-case letters.
Fields
For most searches, you start your search command with a field name. When you start typing in an Advanced Search field, SL1 provides a list of potential fields in a drop-down menu that you can select for your search command:
The list of potential fields depends upon the page you are currently on in SL1. The example above is from the Advanced Search field on the Devices page. If you typed the same letters in the Advanced Search field on the Events page, the drop-down menu would look like this:
The following table lists some of the more common fields, along with how to use them and examples of search commands that use those fields:
| Field name | Purpose | Example |
|---|---|---|
| alignedResourceName | Search for the name of a device aligned with an event. | alignedResourceName contains "lab" |
| asset | Search for an asset aligned with a device. | asset has (assetTag contains 1) |
| attribute | Search for devices based on custom attributes. In the example, the custom attribute is "year" and the value is "2021". | attribute has (id = year and value = 2021) |
| dateCreated | Search for the date and time a device was created. | dateCreated isNotNull |
| deviceClass | Search for devices belonging to a device class. | deviceClass has (class contains 'Cisco') |
| deviceGroup | Search for devices belonging to a device group. | deviceGroup has (name contains "Network") |
| hostname | Search for a device hostname | device has (hostname = "srv") |
| id | Search for the unique numeric ID assigned by SL1. | id contains "10" |
| isAcknowledged | Search for events that have or have not been acknowledged. | isAcknowledged = true |
| message | Search for details about an event message. | message contains "problem" |
| name | Search for the name of the device. | name = "server" |
| organization | Search for the organization to which the device is assigned. | organization has (company = "System")
organization has (company doesNotContain 'ABC Systems') |
| severity | Search for the severity of an event; severities range from 0 to 4, from Healthy to Critical. |
severity in 3,4 Searches for all Major and Critical events. |
| state | Search for the state of a device; states range from 0 to 4: Healthy, Notice, Minor, Major, and Critical. |
state in 0,1,2 Searches for all devices with a state of Healthy, Notice, and Minor. |
| suppressGroup | Hide data related to the specified group. | suppressGroup = sciencelogic |
Operators
For most searches, you follow a field with an operator. The operator establishes a relationship between the field and the value that comes after the operator.
The list of available operators changes based on the page where you are making your search.
The following table lists some of the more common operators, along with how to use them and examples of search commands that use those operators:
| Operator name | Purpose | Example |
|---|---|---|
| and | Include two or more search criteria before producing search results | deviceClass has (description contains 'rds instance') and name contains 'wordpress' |
| or | Include at least one of multiple search criteria. | name = "server" or message contains "error" |
| =, ==, eq | The field and the value are equal. | name == 'ECS 23' and ip doesNotContain '.' |
| <>, !=, neq | The field and the search value are not equal. | field != abc |
| <, lt | The field is less than the search value. | state < 2 |
| >, gt | The field is greater than the search value. | severity > 3 |
| <=, lte | The field is less than or equal to the search value. | state lte 2 |
| >=, gte | The field is greater than or equal to the search value. | severity gte 3 |
| contains | The field includes the specified string. | deviceClass has (description contains 'em7 admin portal') |
| doesNotContain | The field does not include the specified string. | name contains 'SL1 Classic' or (description contains 'PowerFlow' and description doesNotContain 'Not Deployed') or (description contains 'Extended Architecture' and description doesNotContain 'Not Deployed') |
| has | The field contains a specific value. The value following "has" must be enclosed in parentheses. |
deviceClass has (deviceCategory has (name contains 'Server')) and deviceClass has (description doesNotContain 'vcenter') |
| in | The field must be part of a specific set of values. | severity in 2,3,4 |
| not | Opposite values; this operator precedes the field name. | not field = abc |
| isNull | The field is empty. | extTicketRef isNull |
| isNotNull | The field is not empty. | counter isNotNull |
Values
The value you type at the end of a search command depends on the field name and the operator you use. For most searches, you can type the value instead of picking it from the drop-down menu that lists possible search options.
In the following example, the first search value is a string (red text) and the second search value is a numeric value (blue text):
You must use either "quotation marks" or 'apostrophes' for search strings, and strings are not case-sensitive.
Strings
You can create a search command that searches for a specific set of words in a string. You must use either "quotation marks" or 'apostrophes' for your search strings, and strings are not case-sensitive.
The following table lists some of the more common string operators, along with how to use them and examples of search commands that use those string operators:
| String operator name | Purpose | Example |
|---|---|---|
| beginsWith | Search for strings beginning with a specified value | message beginsWith "Host Resource" |
| endsWith | Search for strings ending with a specified value | message endsWith 'shutdown' |
| contains | Search for strings containing a specified value | message contains "problem" |
| doesNotBeginWith | Search for strings that do not begin with a specified value | message doesNotBeginWith "front" |
| doesNotEndWith | Search for strings that do not end with a specified value | message doesNotEndWith 'warning' |
| doesNotContain | Search for strings that do not contain a specified value | message doesNotContain "codec" |
Escape characters
In double-quoted strings (strings surrounded by quotation marks), you can include quotation marks in the search by escaping the quotation marks. To escape those characters, add a backslash before each quotation mark, such as \".
For example:
"Error in \"process x\""
In single-quoted strings, you can include the single-quote character by escaping it with a backslash, such as \'.
For example:
'Eric\'s Laptop'
'Error in "process x"'
You do not need to add quotes around strings in your search commands. However, if your string contains only numbers, you might want to add quotes around it to ensure that SL1 interprets it as a string.
If you do not include quotes around strings in your search commands, you must escape the following characters with a backslash:
- all empty spaces or white spaces
- comma
- end parenthesis
Examples:
Eric's\ Laptop
Error\ in\ "process\ x"
devices\ \(system\,\ server\)
Other than the escape characters mentioned above, you can escape any character. You must escape the backslash character if you want to use it in a string, such as \\.
The normal whitespace escape sequences can be used: \t (tab), \n (new line), \b (backspace), \r (carriage return), and \f (form feed).
You can also use four-digit Unicode hex escape codes in the form \uXXXX.
Examples of Advanced Searches
Because the search commands differ for each page in SL1, this section contains a set of search examples based on context.
To view a list of all possible search commands at any point in an Advanced Search, press .
Advanced Search Examples on the Devices Page
When you run a search in the SL1 user interface, SL1 exposes how the data is stored, which is not always obvious in how this translates to Basic and Advanced searches.
For example, if you have the following device on the Device Manager page in the classic user interface:
You would use the following Basic and Advanced searches to find the following device data:
| Classic User Interface Field | Basic Search Selections | Advanced Search Syntax |
|---|---|---|
| Device Category |
|
deviceClass has (deviceCategory has (name contains 'servers')) |
| Device Class |
|
deviceClass has (logicalName contains 'cisco systems') |
| Sub-class |
|
deviceClass has (description contains 'ucs manager') |
The following table contains additional examples of Advanced Searches for the Devices page:
| Purpose of Advanced Search on Devices Page | Advanced Search Syntax |
|---|---|
| Search for all devices with a Device ID of 1, 2, or 3. | id in 1,2,3 |
| Search for all devices with "rtp" in the Device Name and an IP Address that starts with 192.168. | name contains 'rtp' and ip beginsWith '192.168' |
| Search for all devices with a custom attribute of "year" and the custom attribute value of "2021". | attribute has (id = year and value = 2021) |
| Search for all devices with a custom attribute of "model" and the custom attribute value of "server" that have "CN" in the Device Name. | attribute has (id = model and value = server) and name contains "cn" |
Search for all devices that meet the following criteria:
|
attribute has (id eq 'SL1ComponentType' and value eq 'DC') and attribute has (id eq 'SL1Stack' and value eq 'BigBen') and deviceClass has (logicalName contains 'EM7 Data Collector') |
Search for all devices that meet the following criteria:
|
organization has (company contains 'Onprem') and deviceClass has (description contains 'windows server 2') and ip beginsWith '172' |
| Search for all mail servers based on the organization's naming conventions (all US-based devices start with the prefix of "us-"). | name beginsWith "us-" and name contains "mail" or name contains "smtp" |
| Search for all devices aligned with any organization except for the System and Smart Tech Business organizations. | organization has (company doesNotContain System and company doesNotContain 'Smart Tech Business') |
| Search for all devices with "01" in the Device Name that belong to the ScienceLogic organization. | name contains '01' and organization has (company = sciencelogic) |
| Search for all devices with a Device Category of "Server" or "System". | deviceClass has (deviceCategory has (name contains "server")) or deviceClass has (deviceCategory has (name contains "system")) |
Advanced Search Examples on the Events Page
The following table contains a set of sample Advanced Searches for the Events page:
| Purpose of Advanced Search on Events Page | Advanced Search Syntax |
|---|---|
| Search for events on devices by Device ID of 1, 2, or 3. | device has (id in 1,2,3) |
| Search for all events that contains the word "error" | message contains "error" |
| Search for all events on devices with a Device Category Name of "xtremio". | device has (deviceClass has (deviceCategory has (name contains 'xtremio'))) |
Advanced Search Examples for Dynamic Component Mapping (DCM) Scenarios
Dynamic Component Mapping (DCM) allows SL1 to collect data from a single management system, such as a VMware ESX server, and then use that data to create multiple device records for the entities managed by that single management system. For example, the managed entities for a VMware ESX server would be the Guest VMs hosted by that ESX server.
The following table contains a set of sample Advanced Searches for DCM devices on the Devices page:
| Purpose of Advanced Search | Advanced Search Syntax |
|---|---|
| Search for all host devices from a specific vCenter and add those devices to a Device Service | componentRoot has (name contains "VCSA") and (componentParent has (deviceClass has (description contains 'Host Server')) or componentParent has (deviceClass has (description contains 'ESX'))) |
| Search for SQL servers than run as the master. |
deviceClass has (description contains 'SQL Instance') and componentRoot has (attribute has (id == 'DB_Role'and value contains 'Master')) |
The following sections contain more details about these two Advanced Searches and how they work.
Scenario 1: vCenters
An SL1 system has multiple vCenters, each of which has multiple host servers. You want to include in a Device Service all Virtual Machines (VMs) from just one of the vCenters. This scenario includes the following elements:
-
The vCenter has a host name of VCSA hayward-hq.loc
-
One of the hosts has a Device Class of Host Server, and it contains four VMs
-
One of the hosts has a Device Class of ESX, and it contains 16 VMs
Search 1a
componentRoot has (name contains "VCSA") and deviceClass has (description contains "Virtual Machine")
This search works, but it only returns seven devices instead of the 16 devices you might have expected:
How the query works:
componentRoot has (name contains "VCSA")
This part of the query returns a list of all devices that have a root with a name that includes VCSA.
and deviceClass has (description contains "Virtual Machine")
This part of the query filters the results of the first part of the query to isolate the devices with Device Class of Virtual Machine
The reason why this Advanced Search does not result in the 16 VMs that we can see are hosted by both hosts is that some of the VMs have been merged. As a result, their Device Class has been reset to that of the operating system they are running.
Search 1b
componentRoot has (name contains "VCSA") and (componentParent has (deviceClass has (description contains 'Host Server')) or componentParent has (deviceClass has (description contains 'ESX')))
This search successfully returns all 16 VMs:
How the query works:
componentRoot has (name contains "VCSA")
This part of the query returns a list of all devices that have a root with a name that includes VCSA.
and (componentParent has (deviceClass has (description contains 'Host Server'))
This part of the query filters the results of the first part of the query to isolate the devices that have a parent of the Device Class Host Server.
or componentParent has (deviceClass has (description contains 'ESX')))
This part of the query then does a second search of the results of the first query, looking for devices with parents that have a Device Class of ESX.
Scenario 2: SQL Servers
A DB Cluster has two SQL Servers than run as the master and two SQL servers that run as the slave:
Four times a year the master and slave is swapped between the two pairs. As this is a planned, infrequent, and manual activity, you can manually swap a custom attribute on the four hosting devices to designate if a device is acting as master or slave:
For production or higher frequency and automated swapping, making the switch of the custom attributes could be embedded into a switching script and use the API or GQL interfaces to change the value of the custom attributes.
Searches
deviceClass has (description contains 'SQL Instance') and componentRoot has (attribute has (id == 'DB_Role'and value contains 'Master'))
This search returns the two SQL instances that are running on the two SQL hosts designated as the master pair:
deviceClass has (description contains 'SQL Instance') and componentRoot has (attribute has (id == 'DB_Role'and value contains 'Master'))
This search returns the two SQL instances that are running on the two SQL hosts designated as the slave pair:
How the query works:
deviceClass has (description contains 'SQL Instance')
This part of the query returns a list of all devices that have a Device Class of SQL Instance.
and componentRoot has (attribute has (id == 'DB_Role'and value contains 'Slave'))
This second part of the query then filters the results of the first query to isolate the devices that have a root device with a custom attribute of DB_Role set to Slave.
Performing Bulk Actions
If an inventory page in SL1 displays a list of items, and that page contains a checkbox (
) to the left of each item in the list, you can select two or more items to perform bulk actions on all of the selected items at the same time. For example, on the Devices page, you can select two, twenty, or all of the devices on the page, and then you can assign an icon or align an organization with all of the selected devices.
When you use the checkbox to select one or more items in a list, a set of relevant buttons appear at the top of the page. Click a button to run that action on all of the selected devices:
To select all of the items on a page, click the checkbox at the top of the list. To clear all of the selected items, click the checkbox at the top again.
Pages that contain lists use "infinite scrolling", where the list continues to populate as you scroll toward the bottom of the list. The scrolling stops when you reach the end of the list.
Customizing the SL1 User Interface
A theme is a graphic template this is applied to the user interface. SL1 includes one System Default theme, but you can completely customize the look and feel of your SL1 system by creating new themes.
For example, you could create a theme that replaces the SL1 logo with your company's logo and updates the colors used in the user interface to match those used in your company's branding. You can also choose between a light theme or a dark theme for the user interface.
For more information about customizing the user interface using themes, see
Getting Help and More Information
For product documentation about any page in SL1, click the button at the top right of any page in SL1.
The Help menu appears in a new pane on the right side of the SL1 window:
If you click the View Product Documentation link at the bottom of the Help menu, a product documentation topic specific to the current page appears in a new browser window:
The product documentation includes a Search field at the top of the page that you can use to find additional topics related to the SL1 user interface. To find a specific topic that is longer than one word, enclose all of the key words in parentheses, such as "business services".
Click the button on the right side of the product documentation window to send comments directly to the ScienceLogic Documentation team, such as reporting typos, inaccuracies, questions, or other comments about that specific page in the Product Documentation.
As of version 8.12.2 of SL1, ScienceLogic no longer updates the content that appears when you click the button in the classic user interface. All help content is maintained in
The About Page
For more information about the components used by SL1, click your user name in the navigation bar at the top of any SL1 page and select About.
The current version number of the SL1 user interface displays in the ap2 row at the top of the list of components in the right-hand pane, along with the current version of GraphQL used by SL1. The Platform section lists SL1 version information for the various components in SL1, including Application Server, Collector Unit, and Database details, and All-In-One configurations (AO) where relevant.
In the left-hand pane, click any of the components in the Open Source Components pane to view licensing information about those components, along with links to relevant websites where relevant.
To search for a specific open-source component, type the name of that component in the Search field at the top of the page. The list of components is filtered by your search terms.
Tips and Best Practices for Using the Product Documentation
Use the following tips and best practices when using the ScienceLogic
General
-
To ensure that you are always using the most recent version of the product documentation, check the URL for this site to make sure you are using either https://docs.sciencelogic.com/latest/ or https://docs.sciencelogic.com/<most-recent-release>/.
-
The documentation at this site is the same documentation that appears when you click the button at the top of any SL1 page. The Help topic that appears is based on your current page in SL1.
If you are using a version of SL1 older than version 11.1.0, you can access the product documentation by clicking your user name and selecting Help from the drop-down menu.
-
The documentation at this site contains all manuals for the various features of SL1. You can click the Download manual as PDF link at the top of each chapter to download the PDF version of the manual.
-
If you use the Version dropdown to navigate to a previous version of the product documentation, the Version dropdown on the older version might contain links to archived versions that display a 404 error. The Version dropdown only displays links to currently supported releases of SL1.
Searching the Site
-
To search for a specific item in the product documentation, type the relevant information in the Search bar at the top of the page. After you select a document from the search results page, type the same search into your browser's Search (Ctrl+F).
-
If you are using a multiple-word search for a specific term, enclose those words in quotation marks (""). For example: "business services".
-
To quickly find a video in the product documentation, include the word "video" in your search, along with the topic or feature you want to view. For example: video maps.
-
Use the following command to search the product documentation via the SL1 API: https://docs.sciencelogic.com/latest/#search-<your-query-here>. For example: https://docs.sciencelogic.com/latest/#search-business services.
- After you click a link to a page from the search results, your search term or terms display as one or more highlighted colors. To get rid of the highlights, click the Remove Highlights button (
) on the toolbar at top right of the Help content pane.
Links and Images
-
If your browser opens the PDF in a new browser window when you click the Download manual as PDF link (instead of downloading the PDF), any text you try to copy and paste from that version will not paste correctly. If you need to copy and paste text from a manual, ScienceLogic recommends that you download the PDF instead and open it in Adobe Reader, as the PDF viewer in a browser produces an image of each page instead of the actual text, and any text you copy and paste from the viewer displays without spaces.
-
If a link to an external site does not open properly in a new browser window or tab, right-click the link in the product documentation and select the option to open the link in a new tab or window.
-
An image in the product documentation might appear slightly blurry until you click that image to expand it in a pop-up window.
-
If you clicked to expand an image in a pop-up window, you will need to click the expanded image in its pop-up window to return it to its regular size before you can click another image or link in the product documentation.
-
You can also right-click an image and select Open Image in New Tab from the pop-up menu to make the image display at full size in the new browser tab.
Guides from the "Classic" User Interface
-
As of version 8.12.2 of SL1, ScienceLogic will no longer update the help content that appears when you click the button in the user interface. All help content will be updated and maintained here at https://docs.sciencelogic.com.
As always, to contact the ScienceLogic Documentation team, email us at docs@sciencelogic.com.