We use cookies to offer you a better browsing experience, analyze site traffic, personalize content, and serve targeted advertisements. If you continue to use this site, you consent to our use of cookies.
Allows to obtain information about certain files (size and path), and allows to remove unnecessary files such as the trash or cache files.
Important!
For these Remote Actions to work, special disk permissions must be granted to the Collector. Please refer to our documentation for more details.
Notifies the user and cleans up the Trash Bin and/or the user Cache folder (/Users/$USER/Library/Caches/) depending on the input parameters provided.
Run the script as 'interactive user'. The script should be executed manually.
A timeout of 720 seconds is recommended.
| Label | Description |
|---|---|
| Disk Cleanup Campaign Id | UID of the campaign to allow the user select which clean up level will be applied. Provide an empty GUID to avoid executing this campaign |
| Cleanup Completed Campaign Id | UID of the campaign to notify the user that the cleanup process has finished. Provide an empty GUID to avoid executing this campaign |
| Maximum Delay In Seconds | Maximum random delay set to avoid overloading server hosting virtual machines. Provide a number of seconds less than 600 |
| Cleanup Level | Cleanup level to support Chatbot solution. Relevant only in case an empty guid is provided in DiskCleanupCampaignId parameter. Accepted values are (Light/Deep), Light applied by default |
| Label | Type | Description |
|---|---|---|
| Cleanup Space | Int | Space gained in MB |
A Campaign is triggered to perform a Light (Trash Bin) or a Deep (Trash Bin and Caches folder) clean.
The Campaign can be skipped by providing a "-" (without quotes) instead of a Campaign GUID. In such case, CleanupLevel determines how the clean up will be processed.
CleanupSpace output is based on the difference between the size of the profile before and after the cleaning process.
In order to execute this Remote Action, nxtcod must have full disk permission granted in Security & Privacy > Privacy > Full Disk Access. The configuration steps are documented here.
| DeepCleanupWithCampaign | |
|---|---|
| Test Case | User answer is Deep cleanup. |
| Environment | VM macOS 10.14, 10.15, 11, 12 |
| Results | Success - Trash Bin and Caches are deleted. |
| LightCleanupWithCampaign | |
|---|---|
| Test Case | User answer is Light cleanup. |
| Environment | VM macOS 10.14, 10.15, 11, 12 |
| Results | Success - Trash Bin is deleted. |
| DeepCleanupWithInput | |
|---|---|
| Test Case | Campaign is empty and input is Deep. |
| Environment | VM macOS 10.14, 10.15, 11, 12 |
| Results | Success - Trash Bin and Caches are deleted. |
| LightCleanupWithInput | |
|---|---|
| Test Case | Campaign is empty and input is Light. |
| Environment | VM macOS 10.14, 10.15, 11, 12 |
| Results | Success - Trash Bin is deleted. |
Checks the Trash Bin size and removes its contents if it exceeds a specified total size. You can prompt the user for permission if a campaign id is given.
Run the script as 'interactive user'. The script should be executed manually.
A timeout of 1200 seconds is recommended.
| Label | Description |
|---|---|
| Maximum Delay In Seconds | Maximum random delay set to avoid overloading server hosting virtual machines. Provide number of seconds less than 600 |
| Trash Bin Size in MB | Size in MB to be reached in order to notify the user. Provide number of MB between 100 and 10240 (10 GB) |
| Campaign Id | UID of the campaign to notify the user about the size of their trash bin and offer cleanup. Provide an empty GUID to avoid executing this campaign |
| Operation Completed Campaign Id | UID of the campaign to notify the user about the finish of the cleanup process. Provide an empty GUID to avoid executing this campaign |
| Label | Type | Description |
|---|---|---|
| Trash Bin Size | Int | The size of the user trash bin in MB |
In order to execute this Remote Action, nxtcod must have full disk permission granted in Security & Privacy > Privacy > Full Disk Access. The configuration steps are documented here.
| SizeIsNotReached | |
|---|---|
| Test Case | Trash Bin size does not reach the provided value in BinSizeMB input. |
| Environment | VM macOS 10.14, 10.15, 11, 12 |
| Results | Success - Cleaning process does not run and no prompt is shown to the user. |
| SizeIsReachedAndCampaignIsEmpty | |
|---|---|
| Test Case | Trash Bin size reach the provided value in BinSizeMB input. |
| Environment | VM macOS 10.14, 10.15, 11, 12 |
| Results | Success - Cleaning process run and no prompt is shown to the user. |
| SizeIsReachedAndUserAcceptTheCampaign | |
|---|---|
| Test Case | Trash Bin size reach the provided value in BinSizeMB input and the user accept to run the cleanup process. |
| Environment | VM macOS 10.14, 10.15, 11, 12 |
| Results | Success - Cleaning process run and a prompt is shown to the user. |
| SizeIsReachedAndUserDoesNotAcceptTheCampaign | |
|---|---|
| Test Case | Trash Bin size reach the provided value in BinSizeMB input and the user does not accept to run the cleanup process. |
| Environment | VM macOS 10.14, 10.15, 11, 12 |
| Results | Success - Cleaning process does not run and no prompt is shown to the user. |
Reports disk size for all the files found in the hard disk for a given set of file extensions and lists each file found
Run the script as 'interactive user'. In some environments it might be necessary to run as 'local system'. The script should be executed manually.
A timeout of 720 seconds is recommended.
| Label | Description |
|---|---|
| Maximum Delay In Seconds | Maximum random delay set to avoid overloading server hosting virtual machines. Provide number of seconds less than 600 |
| File Extensions | Comma separated list of file extensions to report ('txt,log,iso,dmg') |
| Minimum File Size Threshold (MB) | Minimum size in MB that a file must have to be included in the report |
| Label | Type | Description |
|---|---|---|
| Total Size | Float | Total size of files matching the provided file extensions in MB |
| File List | StringList | File names list for each file included in the report |
This remote action relies on the Spotlight service. It must be enabled for the root volume in order to find the required files. If it is not enabled the results may be empty and zero size. Requesting a file extension that have a huge amount of files on disk increases the time to get the results. Increasing the timeout property is advised in that case.
| ThresholdProvided | |
|---|---|
| Test Case | Provided a threshold to skip files under a given size |
| Environment | VM macOS 10.14, 10.15, 11, 12 |
| Results | Success - The size of files under a given value are not included in the report |
| EmptyExtensionsInputProvided | |
|---|---|
| Test Case | Input parameter FileExtensions set as empty |
| Environment | VM macOS 10.14, 10.15, 11, 12 |
| Results | Failure - The FileExtensions input parameter must not be empty |
Provides total size of files older and newer than the number of days given as threshold parameter.
Run the script as 'interactive user'. In some environments it might be necessary to run as 'local system'. The script should be executed manually.
A timeout of 720 seconds is recommended.
| Label | Description |
|---|---|
| Path | Full path of the folder to measure. Examples of valid paths are '$HOME/Documents' or '$HOME/Downloads' |
| Threshold In Days | Number of days into the past to consider a file as old |
| Maximum Delay In Seconds | Maximum random delay set to avoid overloading server hosting virtual machines. Provide number of seconds less than 600 |
| Label | Type | Description |
|---|---|---|
| Old Files Size | Float | Total size of files in the given path in MB, older than the Remote Action execution date minus the number of days provided as threshold |
| Recently Modified Files Size | Float | Total size of files in the given path in MB, newer than the Remote Action execution date minus the number of days provided as threshold |
The input parameter 'Path' allows to use $HOME (/Users/username). This variable only works as expected when running this Remote Action as 'current interactive user'.
If the input parameter 'Path' contains special folders, nxtcod must have full disk permission granted in Security & Privacy > Privacy > Full Disk Access. The configuration steps are documented here.
| PathProvided | |
|---|---|
| Test Case | Provided a path to measure the files size. |
| Environment | VM macOS 10.14, 10.15, 11, 12 |
| Results | Success - The size of old and recent files on the device is shown correctly |
| EmptyPathProvided | |
|---|---|
| Test Case | The directory is empty. |
| Environment | VM macOS 10.14, 10.15, 11, 12 |
| Results | Success - The result is 0 since there are no files present in the given directory path |
| PathProvidedDoesNotExist | |
|---|---|
| Test Case | The directory does not exist. |
| Environment | VM macOS 10.14, 10.15, 11, 12 |
| Results | Failure - An error is about that the path does not exist is shown in Execution Status Details |
