- 20 Feb 2025
-
DarkLight
-
PDF
Device Counts
- Updated on 20 Feb 2025
-
DarkLight
-
PDF
The Platform 6 feature version includes the ability to capture the number of “devices” (adapter endpoints) connected to the platform. This new functionality is orchestrated through the getDeviceCount()
API, with access to device count information available through a downloadable CSV file.
One (1) year, or 365-days, of device count data history is retained.
The CSV file, in turn, provides Itential users with a historical device count record that is specific to each adapter endpoint, along with a date/timestamp that is reflective of when the polling was done.
In this article, you will learn how to:
- View historical device count data in the Itential interface.
- Download historical device count data into a CSV file.
- Sort and filter device count information.
- Configure device count data in IP.
Prerequisities
To utilize this new feature you:
- Must have assigned permissions to read/write roles on user and group entities.
- Must have assigned permissions to perform the download.
Refreshing & Downloading Device Count Data
Historical device count data is available through Admin Essentials.
- Navigate to Itential Platform → Admin Essentials. You will see the Device Counts card in the top row (Figure 1).
- Last Count indicates when device count data was last collected (polled).
- Endpoints indicate the total count of devices in the polled data.
- By default, device count data automatically updates at least once per 24-hour interval.
- Click the Download Device Count History link (Figure 2). A copy of a CSV-formatted file is downloaded to your system.
- Go to the location where the CSV file is saved.
- Open the CSV file in your spreadsheet application of choice (e.g., Microsoft Excel, Google Sheets, Smartsheet, etc). In our example (Figure X), Microsoft Excel is used.
Figure 1: Admin Essentials Device Counts
Figure 2: Download Device Count History
Device Count CSV File
Device Count information (headers) may look like this in the CSV file:
<serverId>,<adapter-name>,<date>,<time>,<count>
The items in the CSV file and what they represent are referenced below.
Column Header | Description |
---|---|
ServerId | Uniquely identifies the IP server. |
Adapter Name | The network device name. |
Date | The date the device count polling occurred. |
Local Time | Indicates when the polling occurred. The HH:MM:SS timestamp is the user's local time. |
Count | Total number of devices (adapter endpoints) connected to IP. |
Figure 3: Device Count Data CSV File
Each row of information is specific to an adapter, and the date/time is reflective of when the polling was run.
You can sort/filter device count data by timestamp, from oldest to newest. You can also sort device count data by dates, i.e., before X date and/or after X date.
Assigning Device Count Role Permission
Role-based access for device count data is set through Admin Essentials.
- Login to Itential Platform as an administrator (a user with the
pronghorn.admin
Role). - Navigate to Admin Essentials → Authorization.
- Select the Users from the sidenav menu.
- Locate
admin@pronghorn
role under the Users tab and click the pencil icon to open the Edit User dialog. - Select the
admin
checkbox next to theDeviceCounts
source to add the role. - Click Save to finalize your changes.
Figure 4: Device Count Role Permission
Figure 5: Device Count Role Permission Enabled
Configuring Device Count Polling Interval
From the active profile in Admin Essentials, you can configure the Device Count Polling Interval to set how often Itential Platform polls for a device count.
- Navigate to Admin Essentials → Profiles → Configure (tab).
- Go to Edit Profile Properties and select
systemProps
to display the System Properties. - Set the Device Count Polling Interval to designate the frequency of device polling within a 24-hour period. The default polling interval is set to 1 day (once every 24-hours). The maximum polling period is 168 hours (every 7 days).
Figure 6: Device Count Polling Interval