Endpoints
The Endpoints page describes nodes and their hosts. It shows which Orbital nodes are currently installed. Endpoints are Secure Endpoint computers. The Secure Endpoint UID links back to the Secure Endpoints Console Computers page filtered by GUID.
-
host - A host is a computer that runs an Orbital node and is monitored by the node.
-
node - A node is the Orbital process running on a host that talks to the service and performs work.
View Endpoint Information
Click the host’s name in the table to view detailed endpoint information.
Note: The Show Live Queries toggleswitch, located on the Endpoints Details page will switch the page view to include or exclude live queries in the list of queries running against the node.
Using allowos In Endpoint Searches
The Search Endpoints function, located on the Endpoints page and shown in the figure below, allows the use of the allowos filter in its search string. This filter can be typed into the search field by itself or in conjunction with other search parameters. Refer to the allowos definition in the Query API topic for more information on using the allowos filter.
By including the allowos filter in a search string, you will be telling the endpoint search to return only those endpoints that are running the specified operating system or systems. Essentially, you will be turning on a filter specifically for the identified operation system or systems. The name or names of the specified operating systems will be displayed at the right end of the Search Endpoints field, as shown in the figure below.
Note: Using the allowos filter will only include the specified operating systems. It cannot be used to exclude operating systems. For example, if you type allowos:linux, it will only include endpoints running the Linux operating system in the search results. Typing allowos:linux again will not remove the Linux filter from the search.
The allowos syntax for the Search Endpoints field is as follows:
allowos:[OS Name]
where OS Name is one of the three major operating systems, Linux, macOS, or Windows.
Note: If you wish to include more than one operating system in the filter, you will need to type the allowos command for each operating system you wish to include. For example, if you wish to list results from only those endpoints that are running Linux and Windows, you would first type the command allowos:linux and then type the command allowos:windows.
Download all as [Format Type]
The Download all as [Format Type] function allows you to download the records of all the endpoints associated with your organization. This function is accessed from the Endpoints page, as shown in the figure below.
The records retrieved using the Download all as [Format Type] can be either formatted in a Comma Separated Variable (CSV) file or a JavaScript Object Notation (JSON) file.
Refer to the Setting the Download File Type of the Orbital Settings My Account Tab topic for more information on how to set your default download file type.
Downloading All Endpoint Records for Your Organization
To download all of the endpoint records for your organization, perform the following steps:
- Click the Endpoints tab to access the Endpoints page. The Endpoints tab location is shown in the figure below.
- Click Download all as [CSV | JSON]. The Download all as [CSV | JSON] field location is shown in the figure below.
While the records are being prepared for download, the status message Preparing download… is displayed in the Download all as [CSV | JSON] field.
When the endpoint records have been prepared for download, the message [date] [time] download is ready will be displayed.
- Click [date] [time] download is ready message to begin the download.
Click Cancel if you wish to abort the download.
Note: The downloaded file will be a compressed ZIP file. In order to view the CSV or JSON formatted records, you will have to decompress the ZIP file.