A common request we get is to remove old devices from the console, especially ones that might have been re-imaged. Currently you can do this on the devices page by sorting by Last Disconnected Date and selecting devices to remove. However, this can become unwieldy if you have pages and pages of devices to remove.
This script automates the removal using an API call to check the last disconnected date and remove any devices older than the number of days you specify in the code.
There are four areas in the code you’ll need to update to get the script to function:
$orgID = 'YOUR_ORG_ID'- put your Org ID, which can be found by looking at the URL of your console and selecting the value after the “?o=”: https://console.automox.com/dashboard?o=999999. In this example URL the Org ID is the 999999 portion.
$apiKey = 'YOUR_API_KEY'- in your console, go to Settings->API and select the API key. Note that the API key is per admin user, so you and another admin in your console will have different API keys.
$maxDays = 120- any device that has been disconnected for more than 120 days will be deleted from the console. You can adjust this to the number of days you prefer.
$logPath = 'C:\temp\'- set this to the folder of your choosing
Once you’ve made those four changes, you can run the script below on any Windows device using Powershell.
Note: This script will automatically remove devices from your console and this is not a reversible operation. Any device that you remove unintentionally using this script will have to have the agent reinstalled to return it to your console.
If you wish to run the script in a test mode to see what will be deleted, you can uncomment this line:
#echo "device: $serverName `t last disconnected date: $lastCheckin `t days disconnected: $span.Days"
and comment out the line that does the deletion:
$delResponse = Invoke-WebRequest -UseBasicParsing -Method Delete -Uri $delURI
That will show you a list of all your devices with the date of last disconnect and number of days since that disconnect, and which devices would have been deleted by the script.
Remove Old Disconnected Devices Script:
# o-------------------------------------DISCLAIMER-------------------------------------]
# This script is provided as-is with no implicit
# warranty or support. It's always considered a best practice
# to test scripts in a DEV/TEST environment, before running them
# in production.
# Please proceed with caution.
# Do not distribute your API Key to any untrusted 3rd party.
# /-------------------------------------DISCLAIMER-------------------------------------]
# The SETUP section gets your API return and is not specific to any particular use-case.
# The OPERATIONAL section is specific to one scenario and can be overhauled for your specific uses.
############################# SETUP Section #############################
#modify log path as desired
$logPath = 'C:\temp\'
#Easier to maintain, especially if multiple organizations, or for repurposing for different API Tables
$apiInstance = 'https://console.automox.com/api/'
$apiTable = 'servers'
#replace the two variables below with your Org ID and your API key
$orgID = 'YOUR_ORG_ID'
$apiKey = 'YOUR_API_KEY'
$orgAndKey = "?o=$orgID&api_key=$apiKey"
#Number of days disconnected before deleting - adjust to your desired range
$maxDays = 120
#optional query to filter, if the whole server list is too long, you could add the date filter here
$query = ''
#initialize empty arrays to store server IDs to be deleted
$toDelete = @()
$failDelete = @()
$successDelete = @()
#put components together
$getURI = $apiInstance + $apiTable + $orgAndKey + $query
#Get the json body of the Web Request
$jsonReturn = (Invoke-WebRequest -UseBasicParsing -Method Get -Uri $getURI).Content
#Convert to object with manipulatable properties/values
$servers = $jsonReturn | ConvertFrom-Json
#Export to C
############################# END Setup Section #############################
############################# OPERATIONAL Section #############################
#Check each server for checkin time, conditionally take action
foreach ($server in $servers) {
#pull out wanted details
$serverID = $server.id
$serverName = $server.name
#check to make sure last_disconnect_time isn't null, which it will be for currently connected devices, in which case the lastcheckin variable will be set to today's date
$lastCheckin = Get-Date
if ($server.last_disconnect_time) {
$lastCheckin = edatetime]$server.last_disconnect_time
}
#Calculate time since last checking to now
$span = New-TimeSpan -Start $lastCheckin
#uncomment line below if you want to see all the servers with their last disconnect time and number of days disconnected for troubleshooting
#echo "device: $serverName `t last disconnected date: $lastCheckin `t days disconnected: $span.Days"
if ($span.Days -ge $maxDays) {
#Delete or data collection code here
#Delete method takes serverID only
#Hardcoded would look like this $delURI = https://console.automox.com/api/servers/$serverID?o=YOUR_ORG_ID&api_key=YOUR_API_KEY
$toDelete += @{"ServerName"=$serverName;"ServerID"=$serverID;"last_disconnect_time"=$lastCheckin}
$delURI = $apiInstance + $apiTable + '/' + $serverID + $orgAndKey
#Attempt to delete and track failures
try {
$delResponse = Invoke-WebRequest -UseBasicParsing -Method Delete -Uri $delURI
Write-Output "Successfully Deleted Server: $serverName"
$successDelete += @{"ServerName"=$serverName;"ServerID"=$serverID;"last_disconnectn_time"=$lastCheckin}
}
catch {
$failDelete += @{"ServerName"=$serverName;"ServerID"=$serverID;"last_disconnect_time"=$lastCheckin}
Write-Output "Failed to Delete Server: $serverName"
}
}
#Output logging into json files for later review/manipulation
$toDelete | ConvertTo-Json | Out-File $logPath\ToBeDeleted.json
$successDelete | ConvertTo-Json | Out-File $logPath\Delete_Success.json
$failDelete | ConvertTo-Json | Out-File $logPath\Delete_Failed.json
}
If you have any questions or problems getting this to function correctly please let me know!