Library Pack Header

Allows to obtain information about certain files (size and path), and allows to remove unnecessary files such as the trash or cache files.\n\n'''Important!'''\n\nFor these Remote Actions to work, special disk permissions must be granted to the Collector. Please refer to [https://docs.nexthink.com/platform/latest/installing-collector-profile-in-jamf-for-macos our documentation] for more details.

Disk Cleanup for macOS

This Remote Action is designed to help employees to maintain healthy levels of disk space. It can be used in 2 different formats, either with the Campaign which will provide some information to the employee with the option of a light or deep clean, which the employee can select. Without the campaign, administrators can use the Remote Action to automatically clean the disk according to the input parameter options they supply (Light or Deep).\n\nLight clean only cleans the macOS bin.\n\nDeep clean cleans the macOS bin and user cache folder (/Users/$USER/Library/Caches/).\n\nIt is possible to run a silent execution without user interaction via the Campaign, in this case, the Campaign can be skipped by providing an empty GUID as input DiskCleanupCampaignId. When using this silent method the “cleanup_level” determines how cleanup will be processed.

ID of the campaign to allow the user select which clean up level will be applied

Disk cleanup campaign ID

ID of the campaign to notify the user that the cleanup process has finished

Cleanup completed campaign ID

Maximum random delay set to avoid overloading server hosting virtual machines. Provide a number of seconds less than 600

Maximum delay in seconds

Cleanup level to support Chatbot solution. Relevant only in case an empty guid is provided in disk_cleanup_campaign_id parameter. Accepted values are (Light/Deep), Light applied by default

Cleanup level

Disk cleanup macOS

Cleanup space

Reports disk size for all the files found in the hard disk for a given set of file extensions and lists each file found

Maximum random delay set to avoid overloading server hosting virtual machines. Provide number of seconds less than 600

Comma separated list of file extensions to report ('txt,log,iso,dmg')

File extensions

Minimum size in MB that a file must have to be included in the report

File size minimum threshold in MB

Get file extension total size macOS

Total size of files matching the provided file extensions in MB

Total size

File names list for each file included in the report

File list

Provides total size of files older and newer than the number of days given as threshold parameter.

Full path of the folder to measure. Examples of valid paths are '$HOME/Documents' or '$HOME/Downloads'

Path

Number of days into the past to consider a file as old

Threshold in days

Get old files size macOS

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

Old files size

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

Recently modified files size

This Remote Action helps to conserve disk space on end-user devices by performing a proactive recycle bin clean (compatible on Windows or macOS) with an optional capability to use a Campaign to request user permission.\n\nThe Remote Action checks the recycle bins from all logical drives and determines the size of the files inside.\n\nA cleanup is then performed based on the input parameters 'settings' that you supplied to the Remote Action.\n\n'Warning' the cleanup operation permanently deletes recycle bin data that meets the criteria specified in the input, from all targeted devices.

Size in MB to be reached in order to initiate the action (the campaign will be triggered if selected, otherwise the action will proceed automatically). Provide a number in MB between 100 and 10240 (10 GB) and when that amount of storage usage is reached we will start the cleanup action

Bin size in MB

ID of the campaign to notify the user about the size of their bin and offer cleanup. Provide an empty ID to avoid executing this campaign

Campaign ID

ID of the campaign to notify the user about the finish of the cleanup process. Provide an empty ID to avoid executing this campaign

Operation completed campaign ID

Invoke recycle bin cleanup

The amount of data that we managed to clear from the recycle bin

Recycle bin size

If the recycle bin on the device was cleaned, then we output 'true', otherwise if the clean was not performed this output shows as 'false'

Disk Cleanup for macOS

Description

Versions

Content

Required Products

Platforms

Compatibility