cookie alert

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.

Nexthink Library

Level 1: Checklist Advanced

Back

Level 1: Checklist Advanced

Latest Version: 5.0.1.1
|
Updated on April 17, 2024
Install
Configuration

Description

This pack uses a Score which must be configured by Nexthink Professional Services or by a certified Nexthink partner.

This Level 1: Checklist Advanced library pack works in conjunction with the pack Level 1: Office. It includes a set of remote actions (Windows only) that can be triggered from the score itself.

It will help L1 agents to quickly spot issues and troubleshoot the most common incidents, potentially reducing the number of tickets that are escalated to L2 support. Furthermore, ensuring that endpoints meet the requirements can help avoid L2 support losing time when tickets are escalated. There are a number of proactive single-click resolutions of common L1 problems along with deeper insights into more complex L1 indicators through Nexthink Remote Actions.

Included along with this pack are some example Custom Actions for use within the Finder by the L1 support team. These examples must be configured to be usable with your IT environment.

  • You can find more information on creating and modifying Custom Actions here.
  • You can find the example Custom Actions here.

Screenshots

Versions

  • 5.0.1.1 - 17 Apr 2024 - Minor updates and enhancements
  • 5.0.1.0 - 24 Oct 2023 - Added new "Disk cleanup" combined Remote Action
  • 5.0.0.0 - 27 Jul 2023 - Added "Invoke recycle bin cleanup" Remote Action
  • 4.9.2.2 - 21 Jul 2023 - Minor updates and enhancements
  • 4.9.2.1 - 12 Aug 2022 - Fixed unsigned content in "Get Startup Impact" RA
  • 4.9.2.0 - 29 Jul 2022 - Updated OS requirements
  • 4.9.1.1 - 22 Jul 2022 - Fixing incorrectly referenced Remote Action in score.
  • 4.9.1.0 - 07 Jul 2022 - Minor updates and improvements to score.
  • 4.8.1.0 - 24 Jun 2022 - Improved error handling for campaign responses in "Clear Recycle Bin" Remote Action
  • 4.8.0.0 - 30 May 2022 - Added support for local users on domain joined computers for "Invoke Proactive Password Reset" Remote Action
  • 4.7.0.0 - 23 May 2022 - Deprecating Python in favour of OSAScript for "Kerberos Password Expiration Reminder" Remote Action
  • 4.6.0.0 - 18 May 2022 - Added input parameter "InternalUpdateServer" on "Update Windows Defender Definition" Remote Action
  • 4.5.1.0 - 13 May 2022 - Enhanced documentation and fixed PATH vulnerability in RA "Restart-Device" v3.2.2.0
  • 4.5.0.0 - 28 Apr 2022 - Improved CIM data retrieval and added compatibility for Windows Servers on "Invoke Windows Update" Remote Action
  • 4.4.0.0 - 19 Apr 2022 - Implemented usage of improved functions to retrieve OS management information on "Get BitLocker Information" Remote Action
  • 4.3.0.0 - 22 Mar 2022 - Updated "Get BitLocker Information" Remote Action
  • 4.2.1.0 - 21 Mar 2022 - Documented KB Fix URL for "Get Startup Impact" Remote Action v4.2.1.0
  • 4.2.0.0 - 21 Mar 2022 - Added compatibility for Windows 8.1 devices on "Get WiFi Signal Strength" and "Get Startup Impact" Remote Actions
  • 4.1.0.1 - 10 Mar 2022 - Fixed system drive free space inaccuracy in "Disk Cleanup" Remote Action v5.1.1.1
  • 4.1.0.0 - 07 Feb 2022 - Added input parameter to Anonymize BSSID data on "Get WiFi Signal Strength" Remote Action
  • 4.0.5.0 - 03 Feb 2022 - Updated campaign error handling on "Get Wi-Fi Signal Strength" Remote Action
  • 4.0.4.0 - 21 Dec 2021 - Fixed bug in "Invoke Windows Update" Remote Action
  • 4.0.3.0 - 21 Dec 2021 - Fixed system drive free space inaccuracy in "Disk Cleanup" Remote Action
  • 4.0.2.0 - 29 Nov 2021 - Added support of urgent campaigns for "Restart Device" Remote Action
  • 4.0.1.0 - 12 Nov 2021 - Fixed "Get Wi-Fi Signal Strength" Remote Action to avoid errors in different languages
  • 4.0.0.0 - 26 Oct 2021 - Added "Kerberos password expiration reminder" Remote Action
  • 3.4.0.0 - 25 Oct 2021 - Updated campaign urgency and version for "Invoke Proactive Password Reset" Remote Action
  • 3.3.0.0 - 13 Sep 2021 - Added output 'TPMVersion' to "Get BitLocker Information" Remote Action
  • 3.2.0.1 - 07 Sep 2021 - Updated scheduling information for "Get Wi-Fi Signal Strength" Remote Action
  • 3.2.0.0 - 25 Jun 2021 - Added compatibility for Azure Domain joined devices to "Disable Application from Startup menu" Remote Action
  • 3.1.0.0 - 25 Jun 2021 - Added compatibility for Azure Domain joined devices to "Get Startup Impact" Remote Action
  • 3.0.1.1 - 21 Jun 2021 - Minor bugfixes and enhancement to the proactive password reset Remote Action
  • 3.0.1.0 - 17 Jun 2021 - Minor bugfixes and updated proactive password reset Remote Action to now support macOS
  • 3.0.0.0 - 02 Jun 2021 - Added macOS compatibility to "Get WiFi Signal Strength" Remote Actions
  • 2.3.0.0 - 14 Apr 2021 - Updated "Clear Recycle Bin", "Disable Application from Startup menu", "Restart Device" and "Disk Cleanup" Remote Actions description
  • 2.2.1.0 - 11 Mar 2021 - Fixed "Get Wi-Fi Signal Strength" Remote Action data retrieval by obtaining the numeric values in the right format
  • 2.2.0.0 - 15 Jan 2021 - Fixed "Restart Device" Remote Action logic to evaluate pending restarts and modified input parameter name 'DeviceUptimeInDays' to 'NumberOfDaysSinceLastReboot'
  • 2.1.1.0 - 04 Jan 2021 - Fixed a problem with an input in "Restart Device" Remote Action
  • 2.1.0.0 - 09 Oct 2020 - Updated "Get Wi-Fi Signal Strength" Remote Action
  • 2.0.2.0 - 30 Sep 2020 - Fixed "Disable Application from Startup menu" Remote Action
  • 2.0.1.0 - 30 Jul 2020 - Fixed a problem with date format in "Restart Device" Remote Action
  • 2.0.0.0 - 07 Jul 2020 - Updated score for DEX V2
  • 1.1.0.0 - 08 May 2020 - Added key remote worker checks and Remote Actions
  • 1.0.1.1 - 06 May 2020 - Update description
  • 1.0.1.0 - 08 Apr 2020 - Fixed documentation
  • 1.0.0.0 - 31 Mar 2020 - Initial release

Required Products

Nexthink Act
Nexthink Engage

Platforms

Windows 10 and newer
MacOS Catalina and newer

Compatibility

V6.20 and later

This Might Interest You

Workflow: Windows 11 migration
New

Orchestrate the Windows 11 migration process with automated compatibility checks and pre-to-post migration user engagement.

Released on April 11, 2024
View Library Pack

Workflow: Device assignment verification
New

Orchestrate the verification and update of device assignee information in the ServiceNow Hardware Asset Management database through a dedicated workflow.

Released on April 10, 2024
View Library Pack

Get Hardware And BIOS Information

Script Description

Returns detailed information concerning the Graphics Processing Unit (GPU) and RAM installed on the device. Additionally, the script obtains the serial numbers and types of the installed disks, as well as the BIOS version and release date.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed manually.

A timeout of 120 seconds is recommended.

Parameters

None.

Outputs

Label Type Description
GPU Name StringList Name of the graphics card installed on the device
GPU Driver Vendor StringList Provider of the graphics card driver
GPU Driver Version StringList Version of the graphics card driver
Disk Serial Number and Type StringList For each installed disk drive, the number allocated by the manufacturer to identify the physical media and its type (HDD/SDD)
Total RAM Slots Int Total number of memory slots available on the device
Maximum RAM Size Maximum total amount of RAM that can be installed on the device
Used RAM Slots Int Number of memory slots currently used
Installed RAM Size Amount of RAM currently installed
RAM Bank Capacity StringList Capacity of each installed memory bank
RAM Bank Device Locator StringList For each installed memory bank, label of the socket or circuit board that holds the memory
RAM Bank Form Factor StringList For each installed memory bank, implementation form factor for the chip
RAM Bank Manufacturer StringList For each installed bank, name of the organization responsible for producing the physical element
RAM Bank Part Number StringList For each installed bank, part number assigned by the organization responsible for producing or manufacturing the physical element
RAM bank serial number StringList For each installed bank, manufacturer-allocated number to identify the physical element
RAM Bank Speed StringList For each installed memory bank, speed of the physical memory, in nanoseconds
RAM Bank Voltage StringList For each installed memory bank, configured voltage for this device, in millivolts
RAM Bank Total Width StringList For each installed memory bank, total width, in bits, of the physical memory, including check or error correction bits
Registry BIOS Version String BIOS version installed on the device obtained from the registry
Windows management BIOS Version String BIOS version installed on the device obtained from the WMI Object 'Win32_BIOS'
BIOS Date String BIOS release date installed on the device

Further Information

The ability to get the types of disks installed on the device is only available where possible for endpoints running Windows 10 and above.
When it is not possible to retrieve such information, 'Unknown' will be displayed in the outputs.

Test Scenarios

SuccessfulExecution
Test Case Execute the remote action successful
Environment VM Win7 x64 - VM Win10 x64 (Multi-language) - Win10 x64 EN
Results Success - The remote action is executed without errors and all the retrieved information of the devices is shown
BIOSDateIsString
Test Case Check BIOSDate type is String in the Remote Action in Finder
Environment VM Win7 x64 - VM Win10 x64 (Multi-language) - Win10 x64 EN
Results Success - In Finder the output BIOSDate is type String
OutputBIOSDateIsUniversalFormat
Test Case Check BIOSDate format after executing the Remote Action
Environment VM Win7 x64 - VM Win10 x64 (Multi-language) - Win10 x64 EN
Results Success - After the execution of the Remote Action the format is Universal format ('yyyy/MM/dd HH:mm:ssk')

Invoke Windows Update

Script Description

Restarts Windows Update service and starts BITS service (if needed). It forces the device to scan for system updates. The script is designed for Windows 7, 10 and 11.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed manually.

A timeout of 720 seconds is recommended.

Parameters

Label Description
Maximum Delay In Seconds Maximum random delay set to avoid virtual environment and network overload. Provide number of seconds less than 600

Outputs

None.

Restrictions

Further Information

Parameter 'MaximumDelayInSeconds' can be used to add random script execution delay. It should be used to spread over time number of I/O requests on server hosting virtual machines and reduce network workload.

Get Wi-Fi Signal Strength

Script Description

Retrieves Wi-Fi signal quality, strength and channel, as well as whether the device is connected to a corporate network or not.

Execution context and suggested scheduling

Run the script as 'interactive user'. The script should be executed every 1 hour.

A timeout of 720 seconds is recommended.

Parameters

Label Description
Corporate Networks Comma-separated list of SSIDs which are defined as corporate. It can be empty
Acceptable Signal Quality Minimum signal quality percentage to consider the current wireless network as good (0 to 100)
Nearby Networks Acceptable Signal Quality Minimum signal quality percentage to consider nearby networks to be competing with the current wireless network (0 to 100)
Nearby Networks Maximum Signal Difference Maximum signal percentage difference between the current wireless network and the available networks to consider them as competing (0 to 100)
Alert User After Bad Signals Number of times (1 to 200) the signal has to be under the acceptable threshold during current day to notify the user via a campaign
Anonymize BSSID If set to 'true' BSSID data for Wifi networks will not be displayed 'ANONYMIZED' will be shown
Campaign Id Campaign to show to recommend to get closer to the router. Use an empty GUID (00000000-0000-0000-0000-000000000000) or '' to avoid campaign

Outputs

Label Type Description
Connected To Corporate Wi Fi Bool If the device is connected to a wireless network categorized as corporate
Wi Fi Signal Quality Ratio Signal quality percentage as presented by Windows
Wi Fi Signal Quality Average Ratio Wi-Fi signal quality average during the current day
Wi Fi Strength In Dbm Float Signal strength in dBm
Bad Signal Count Int Number of times the Wi-Fi signal quality was below the acceptable signal threshold during the current day
Bad Signal Percentage Ratio Percentage of time the Wi-Fi signal quality was below the acceptable signal threshold during the current day
Wi Fi Speed BitRate Speed of the connected wireless network in Mbps (Megabits per second)
Wi Fi Radio Type String Radio type used by the device's adapter connected to the active wireless network
Wi Fi Channel Int Channel used by the active wireless network
Co Channel Congestion Bool If there is noise caused by competing networks using the same channel as the active wireless network
Co Channels List StringList Details of the co-channel competing networks if there are any. The list is in CSV format
Adjacent Channels Congestion Bool If there is noise caused by competing networks using adjacent channels with respect to the active wireless network
Adjacent Channels List StringList Details of the adjacent competing networks if there are any. The list is in CSV format

Further Information

The Windows Remote Action informs users who have a connection strength lower than the threshold specified that their connection is not good for optimal work.

The macOS Remote Action only works on devices connected to a wireless network (Wi-Fi).

Note: use as empty input value '""' for Windows and '-' for macOS. This input parameter is defined as dynamic with the available two options.

Test Scenarios

UserInCorporateWiFi
Test Case The user is working in a corporate network
Environment Windows 10 x64 (English) (1903)
Results The campaign is not shown, strength is returned no other checks performed
UserWorkingFromHome1
Test Case The user is working from home and has good strength
Environment Windows 7 x86 (English) - Windows 10 x64 (English) (1903)
Results The campaign is not shown, strength is returned and all the checks are performed
UserWorkingFromHome2
Test Case The user is working from home and has poor strength
Environment Windows 7 x86 (English) - Windows 10 x64 (English) (1903)
Results The campaign is shown, strength and user feedback is returned
UserConnectedViaCable
Test Case The user is connected via cable
Environment VM Windows 7 x86/x64 (Multi-language) - Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results A message is displayed with the default outputs
NetworkNoiseCausedByCoChannels
Test Case The user is connected to a network that is using the same channel than others nearby
Environment Windows 7 x86 (English) - Windows 10 x64 (English) (1903)
Results Success - 'CoChannelCongestion' output is true. 'CoChannelsList' output contains a list of co-channel networks, in CSV format
NetworkNoiseCausedByAdjacentChannels
Test Case The user is connected to a network that is using a channel that is intersecting other networks' frequencies
Environment Windows 7 x86 (English) - Windows 10 x64 (English) (1903)
Results Success - 'AdjacentChannelsCongestion' output is true. 'AdjacentChannelsList' output contains a list of adjacent channel networks, in CSV format

Restart Windows Device

Script Description

Retrieves information if restart is necessary due to too long device uptime or pending reboot, and based on provided input configures restart of target device. Campaign is displayed to enable user immediate restart, or postpone till next script execution. After restart, previously opened user's applications are restored.

Warning: The 'Device Restart' Remote Action restarts devices based on the provided input parameters. Avoid choosing parameters that cause users to be regularly prompted, or forced, to restart their device.

Execution context and suggested scheduling

Run the script as 'interactive user'. The script should be executed every 1 day.

A timeout of 720 seconds is recommended.

Parameters

Label Description
Number Of Days Since Last Reboot Number of days considered as maximum allowed without device restart. Accepted values are (0-60)
Test Pending Restart Test if a reboot is needed. Accepted values are (True/False)
Show Campaign Determines under what circumstances the campaign should be shown. Accepted values are (Always/DuringGracePeriod/OnlyFirstExecution/Never)
Campaign Id Id of a campaign to be presented to user before triggering restart
Postpone Grace Period In Days Number of days provided for user to postpone campaign, verified with hourly precision. Once due date is passed, restart will be scheduled. Accepted values are (1-30)
Restart Delay In Seconds Number of seconds provided as delay before restart is executed. Accepted values are (45-86400)
Campaign Timeout Number of seconds provided before the campaign times out. Accepted values are (60-600). This input will only be taken into account when ShowCampaign input is different from never

Outputs

None.

Further Information

For a deeper understanding of the usage of this Remote Action, read the official Nexthink Documentation here.

ShowCampaign input parameter behaviour:

- Always - The campaign is always shown to the user, and the user can decide if he wants to restart the device (Yes, restart) or if he wants to postpone the campaign (Postpone).

- Never - The campaign is never shown to the user. The device is restarted using the "RestartDelayInSeconds" input parameter. For e.g., if "RestartDelayInSeconds" is set to 300, once the RA is triggered on the device, the device is will restart after 300 seconds.

- OnlyFirstExecution - The campaign is shown only one time to the user, and the user can decide if he wants to restart the device (Yes, restart), or if he wants to postpone the campaign (Postpone). If the user decides to postpone the campaign, and the RA gets triggered another time on the device, this latter will be restarted using the "RestartDelayInSeconds" input parameter.

- DuringGracePeriod - If we use this parameter, the RA is going to take into account the PostponeGracePeriodInDays. It means that if we use 7 days as PostponeGracePeriodInDays, the campaign is shown during 7 days to the user. If the user restarts the device in the meantime, the counter is reset and the campaign is not shown anymore. But if the user does not restart the device during the 7 days of grace period, the device will be restarted on the 8th day using the RestartDelayInSeconds input.

Clarification - Postpone button in the campaign does not postpone the restart. It only postpones the campaign i.e. the user could receive the campaign again if the configuration allows it, but the restart is not postponed.

Test Scenarios

PatchPendingInstallation
Test Case .NET Hotfix was just installed
Environment Win7 Pro (multiple languages), Win10 Enterprise 1803 various applications were opened
Results Campaign was displayed, restart notifications were displayed, after restart all applications were restored.
DeviceIsCompliant
Test Case Device recently restarted, no pending hot-fixes
Environment Win7 Pro (multiple languages), Win10 Enterprise 1803
Results Script reported restart was not needed.
DeviceUptimeIsTooLong
Test Case Device was not restarted for longer than provided threshold, no pending hot-fixes
Environment Win7 Pro (multiple languages), Win10 Enterprise 1803
Results Script was processed, restart notifications were displayed, after restart all applications were restored.

Clear Internet Explorer 11 settings

Script Description

Clears Internet Explorer files according to the specified parameters. Useful for troubleshooting several browsing-related issues. The script is designed for Windows 10 and 7 and Internet Explorer 11.

Execution context and suggested scheduling

Run the script as 'interactive user'. The script should be executed manually.

A timeout of 120 seconds is recommended.

Parameters

Label Description
Browsing History List of visited websites. Set it to "true" for deletion, "false" otherwise
Cookies Cookies and files saved on the device by websites. Set it to "true" for deletion, "false" otherwise
Forms Data Saved information typed into forms. Set it to "true" for deletion, "false" otherwise
Passwords Saved passwords. Set it to "true" for deletion, "false" otherwise
Temporary Files Copies of webpages, images and media. Set it to "true" for deletion, "false" otherwise

Outputs

Label Type Description
Cleaned Settings StringList List of cleaned settings

Get Startup Impact

Script Description

Retrieves information of application impact on login process of last logged in user. Result data is similar to the information in the Startup tab in Windows Task Manager, enhanced by detailed impact of each application.

An issue related to Startup Impact measure was fixed by Microsoft in this KB. Please make sure to install it to properly measure Startup Impact.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed manually.

A timeout of 120 seconds is recommended.

Parameters

Label Description
Applications To Exclude Parameter is used to remove all processes matching provided name(s) from output. Multiple entries are separated by comma. Does not accept illegal characters. For more information see this article
XML Max Age in Days Parameter is used to avoid using files old files. The range goes from 0 (same day) to 60

Outputs

Label Type Description
User SID String User SID (Security Identifier) to whom the XML file containing the stats belongs
Last Start Up Analysis Date DateTime Last time the startup information was updated on the device
High Impact Count Int Number of applications with a high startup impact
High Impact Applications StringList Details (CPU time in ms, Disk I/O in MB) of programs with a high startup impact
High Impact Actionable Applications StringList Actionable names of programs with a high startup impact
High Impact Remove StringList Application names with a high startup impact that can only be removed
Medium Impact Count Int Number of applications with a medium startup impact
Medium Impact Applications StringList Details (CPU time in ms, Disk I/O in MB) of programs with a medium startup impact
Medium Impact Actionable Applications StringList Actionable names of programs with a medium startup impact
Medium Impact Remove StringList Application names with a medium startup impact that can only be removed
Low Impact Count Int Number of applications with a low startup impact
Low Impact Applications StringList Details (CPU time in ms, Disk I/O in MB) of programs with a low startup impact
Low Impact Actionable Applications StringList Actionable names of programs with a low startup impact
Low Impact Remove StringList Application names with a low startup impact that can only be removed
Not Measured Impact Applications StringList Applications that were started but whose startup impacts were not measured by Microsoft Windows
Not Measured Impact Actionable Applications StringList Actionable names of programs not measured by Microsoft Windows
Not Measured Impact Remove StringList Application names with a not measured startup impact that can only be removed

Further Information

Result data of 'ActionableApplications' output fields can be actioned with this Remote Action.
Due a known limitation of event tracing logging in Windows, if the number of sessions subscribed to Winlogon provider is 6 or more, DiagPerf is skipped to avoid High CPU, Memory and Disk usage during startup Microsoft Documentation.
If applications appears in the 'actionable' and 'remove' outputs means that the only action able is to remove it completely from startup (it's not possible to undo it).

Test Scenarios

MultipleStartupProcessDataFiles
Test Case Execute the script on machines with multiple XML files in Windows StartupInfo location.
Environment VM Windows 10 x64 EN, VM Windows 10 x86 EN, VM Windows 10 x64 ES
Results Success - Last file that was written to was selected for data processing.
OutputFieldsFormat
Test Case Execute the script on machines with startup process data file containing all types of startup impact data.
Environment VM Windows 10 x64 EN, VM Windows 10 x86 EN, VM Windows 10 x64 ES
Results Success - All results are displayed correctly, 'Count' output fields as numbers, others as string lists.
NotMeasuredAndDisabledApplicationsDetection
Test Case Execute the script on machines with applications configured as startup disabled, or not included in startup process data file due to recent installation without reboot.
Environment VM Windows 10 x64 EN, VM Windows 10 x86 EN, VM Windows 10 x64 ES
Results Success - Disabled or not measured applications are returned properly.
ApplicationsOutputIncludeActionableNames
Test Case Execute the script on machines with startup process data file containing various impact levels.
Environment VM Windows 10 x64 EN, VM Windows 10 x86 EN, VM Windows 10 x64 ES
Results Success - Output fields 'ActionableApplications' contain list of all application 'actionable' (as in registry) names for given impact level.
ApplicationImpactOutputFormat
Test Case Execute the script on machines with startup process data file not containing any 'Process' data.
Environment VM Windows 10 x64 EN, VM Windows 10 x86 EN, VM Windows 10 x64 ES
Results Success - Output fields 'ApplicationImpact' is correctly formatted as '-' and respective 'Count' as '0'.
TestWindows7
Test Case Execute the script on Windows 7 machine.
Environment VM Windows
Results Failure - Exception thrown with message which OS is compatible.
StartupDataDoNotExist
Test Case Execute the script on machine with missing startup process data file.
Environment VM Windows 10 x64 EN
Results Failure - Exception thrown with message file does not exist or is not accessible.

Set Fast Start Status

Script Description

Enables or disables the Windows OS Fast Start feature based on the input provided.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed manually.

A timeout of 120 seconds is recommended.

Parameters

Label Description
Fast Start Status Desired status of the Fast Start. Valid status are 'Enabled' or 'Disabled'

Outputs

None.

Further Information

Fast Start is a feature that provides a faster loading of Operating System that contributes to improved boot time when starting up a device.

Test Scenarios

ChangeToEnabled
Test Case Input FastStartStatus is 'Enabled'.
Device had the Fast Start disabled.
Environment Windows 10 x86/x64
Results success - The Fast Start was already enabled.
ChangeToDisabled
Test Case Input FastStartStatus is 'Disabled'.
Device had the Fast Start enabled.
Environment Windows 10 x86/x64
Results success - The Fast Start has been disabled correctly.
StayEnabled
Test Case Input FastStartStatus is 'Enabled'.
Device had the Fast Start enabled.
Environment Windows 10 x86/x64
Results success - The Fast Start was already enabled.
StayDisabled
Test Case Input FastStartStatus is 'Disabled'.
Device had the Fast Start disabled.
Environment Windows 10 x86/x64
Results success - The Fast Start was already disabled.
IncompatibilityWithWindows7
Test Case This remote action doesn't support Windows 7 devices.
Environment Windows 7 x86/x64
Results failure - This script is compatible with Windows 10 only.

Disk cleanup

Script Description

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).

Light clean only cleans the recycle bin.

Deep clean on macOS cleans the bin and user cache folder (/Users/$USER/Library/Caches/).

Deep clean on Windows cleans the recycle bin and user temporary files.

It 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 disk_cleanup_campaign_id. When using this silent method the “cleanup_level” determines how cleanup will be processed.

Execution context and suggested scheduling

Run the script as 'interactive user'. The script should be executed manually.

A timeout of 720 seconds is recommended.

Parameters

Label Description
disk cleanup campaign id ID of the campaign to allow the user select which cleanup process will be done. Provide an empty ID to avoid executing this campaign
cleanup completed 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
remove files not modified in days Files modified less recently than this threshold will be deleted. Provide number of days
maximum delay in seconds Maximum random delay set to avoid overloading server hosting virtual machines. Provide number of seconds less than 600
cleanup level Cleanup level to support Chatbot solution. Relevant only in case empty guid is provided in disk_cleanup_campaign_id parameter. Accepted values are (Light/Deep), by default Light is applied

Outputs

Label Type Description
cleanup space Size Space freed

Further Information

A Campaign is triggered to perform a Light (Recycle bin) or a Deep (Recycle Bin and Caches folder) clean.

cleanup_space output is based on the difference between the size of the profile before and after the cleaning process.

-macOS-

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.

-Windows-

All files inside user temporary folder (%TEMP%) whose last write time is older than 'remove_files_not_modified_in_days' input parameter, will be removed if deep cleanup option is selected in the campaign. Parameter 'maximum_delay_in_seconds' can be used to add random script execution delay. It should be used in virtualized environments to spread over time number of I/O requests on server hosting virtual machines.

The space freed is calculated by using the 'Free' property of the command Get-PSDrive before and after the execution.

It may be unaccurate or even report 0 in certain situations due to the fact that external applications or services could be occupying the free space by downloading, creating or unzipping files. In those cases, the remaining space after the Remote Action execution could be lower than the total space freed by it.

Test Scenarios

LightWithoutCampaigns
Test Case Both campaigns IDs are an empty GUID.
Cleanup Level is 'Light'.
remove_files_not_modified_in_days is 0.
Environment Windows 10 x86/x64 - Windows 7 x86/x64
Results Success - All files in the recycle bin are deleted silently.
LightWithCampaigns
Test Case Both campaigns IDs are the default value.
The end user select Light cleanup on the first campaign.
remove_files_not_modified_in_days is 0.
Environment Windows 10 x86/x64 - Windows 7 x86/x64
Results Success - All files in the recycle bin are deleted.
All campaign are called.
LightWithoutFirstCampaign
Test Case First campaign GUID is empty.
Second campaign GUID has default value.
Cleanup Level is 'Light'.
remove_files_not_modified_in_days is 0.
Environment Windows 10 x86/x64 - Windows 7 x86/x64
Results Success - All files in the recycle bin are deleted.
Only the second campaign is called.
DeepWithoutCampaigns
Test Case Both campaigns IDs are an empty GUID.
Cleanup Level is 'Deep'.
remove_files_not_modified_in_days is 0.
Environment Windows 10 x86/x64 - Windows 7 x86/x64
Results Success - All files in the recycle bin and the temp folder are deleted silently.
DeepWithCampaigns
Test Case Both campaigns IDs are the default value.
The end user select Deep cleanup on the first campaign.
remove_files_not_modified_in_days is 0.
Environment Windows 10 x86/x64 - Windows 7 x86/x64
Results Success - All files in the recycle bin and the temp folder are deleted.
All campaigns are called.
DeepWithoutFirstCampaign
Test Case First campaign GUID is empty.
Second campaign GUID has default value.
Cleanup Level is 'Deep'.
remove_files_not_modified_in_days is 0.
Environment Windows 10 x86/x64 - Windows 7 x86/x64
Results Success - All files in the recycle bin and the temp folder are deleted.
Only the second campaign is called.
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.

Kerberos password expiration reminder

Script Description

Checks password expiration date and if it is within the time frame provided by the input parameter, runs a campaign to warn the user (providing a link to reset the password).This script is compatible with devices running Kerberos user management.

Execution context and suggested scheduling

Run the script as 'interactive user'. The script should be executed every 1 day.

A timeout of 120 seconds is recommended.

Parameters

Label Description
Campaign Id ID of the campaign to notify the user that the password is about to expire. This input can be set to empty (-) to avoid notifying the user
Days Until Expiration Number of days left for the password to expire. If expiration date is inside this time frame, the campaign is triggered

Outputs

Label Type Description
Days Until Expiration Int DaysUntilExpiration

Test Scenarios

DeviceIsUsingKerberos
Test Case The target device is using Kerberos and password is about to expire
Environment VM macOS 10.16
Results Success - The user was notified that the password is about to expire
DeviceIsNotUsingKerberos
Test Case The target device is not using Kerberos
Environment VM macOS 10.16
Results Success - The IT admin was informed that the user is not joined to any Kerberos domain/realm

Update Windows Defender Definition

Script Description

If the device does not have the last version of the Windows Defender malware or spyware definition, it will force an update.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed manually.

A timeout of 840 seconds is recommended.

Parameters

Label Description
Maximum Delay In Seconds Maximum random delay set to avoid overloading the network. Provide number of seconds less than 600
Internal Update Server If set to 'true' it will update from an internal service such as WSUS or System Center. If set to 'false' it will update directly from Microsoft. Acceptable values are 'true' or 'false'

Outputs

None.

Restrictions

Get BitLocker Information

Script Description

Returns basic information of BitLocker protection status, including whether volume and key are secured, encryption percentage level, used encryption algorithm, and the protectors used to secure the key.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed manually.

A timeout of 120 seconds is recommended.

Parameters

None.

Outputs

Label Type Description
TPM Version String Indicates the TPM version
TPM Present Bool If the TPM chip is present on the device
Protection Status String Indicates whether the volume and its encryption key (if any) are secured
Conversion Status String The status of the encryption or decryption on the volume
Encryption Method String The encryption algorithm and key size used on the volume
Key Protectors StringList Lists of protectors used to secure the volume's encryption key
TPM Is Enabled Bool If the device has a TPM enabled
TPM Is Active Bool If the device has a TPM activated
TPM Is Owned Bool If the device has a TPM owned
AD GPO Enabled Bool If the device has the GPO for AD backup enabled
System Drive Ready Bool If the device has the system drive on a NTFS file system

Further Information

Remote Action is compatible with Windows 10 only.
In case of target device not having volumes that could be handled by BitLocker, output will be empty.

Test Scenarios

EncryptedDevice
Test Case Information correctly retrieved
Environment Windows 10 x64 (1809,1903) on Dell Latitude E7470, Lenovo T480s
Results Success - results retrieved match data verified locally
UnencryptedDevice
Test Case Information correctly retrieved
Environment VM Windows 10 x64 multi-language (1809,1903)
Results Success - results retrieved match data verified locally
DeviceWithNoCompatibleVolume
Test Case Information correctly retrieved
Environment VM Windows 10 x86 (1803)
Results Success - results are empty
ThereIsATPM
Test Case The device has a TPM.
Environment Physical Windows 10 x64 English (1809)
Results Success - TPM configuration is correctly shown in the outputs.
ThereIsNoTPM
Test Case The device does not have a TPM.
Environment VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - 'TPMPresent' shows 'False'. All TPM configuration fields display 'no' or '-'.
SystemDriveFileSystemIsNTFS
Test Case System drive file system is NTFS.
Environment Physical Windows 10 x64 English (1809)
Results Success - 'SystemDriveReady' displays 'yes'.
Windows7Check
Test Case The device OS is Windows 7.
Environment VM Windows 7 x64 (Multi-language)
Results Failed - 'Execution Status Details' field shows 'This script is compatible with Windows 10 only. '.

Invoke Proactive Password Reset

Script Description

Checks password expiration date and if it is within the time frame provided by the input parameter, runs a campaign to warn the user (providing link to reset the password).

Execution context and suggested scheduling

Run the script as 'interactive user'. The script should be executed manually.

A timeout of 720 seconds is recommended.

Parameters

Label Description
Campaign Id ID of the campaign to notify the user that the password is about to expire and to provide the URL to reset it
Days Until Expiration Number of days left for the password to expire. If expiration date is inside this time frame, the campaign is run
Maximum Delay In Seconds Maximum random delay set to avoid domain controller overload. Provide number of seconds less than 600
Password Expiration Policy In Days Number of days for the password to expire since it is set

Outputs

Label Type Description
Days Until Expiration Int Number of days left until password expiry
Password Never Expires Bool Returns if the user password never expires

Test Scenarios

PasswordIsValid
Test Case Account password is within time range
Environment Windows 7 x86/x64 multiple languages, Windows 10 x64 (1809, 1903)
Results Password verified, no action taken and outputs updated.
PasswordExpiresSoon
Test Case Account password is about to expire
Environment Windows 7 x86/x64 multiple languages, Windows 10 x64 (1809, 1903)
Results Campaign is displayed and outputs updated.
PasswordIsExpired
Test Case Account password is expired
Environment Windows 7 x86/x64 multiple languages, Windows 10 x64 (1809, 1903)
Results Notification sent via execution status and no action taken for the user.
PasswordAboutToExpire
Test Case User password is about to expire
Environment macOS 10.14 EN
Results Success - The user receives a campaign asking to renew their password because it is about to expire
PasswordNotExpiring
Test Case User password age is recent
Environment macOS 10.14 EN
Results Success - No campaign sent to the user because the password is not expiring before the expected number of days

Clear Chrome settings

Script Description

Clears Chrome files according to the specified parameters. Useful for troubleshooting several browsing-related issues.

Execution context and suggested scheduling

Run the script as 'interactive user'. The script should be executed manually.

A timeout of 720 seconds is recommended.

Parameters

Label Description
Browsing History List of visited websites. Set it to "true" for deletion, "false" otherwise
Cache Cached images and sites. Set it to "true" for deletion, "false" otherwise
Cookies Cookies saved on the device by websites. Set it to "true" for deletion, "false" otherwise
Clear Chrome Settings Campaign Id ID of the campaign to notify the user that Chrome must be closed
Operation Completed Campaign Id ID of the campaign to notify the user that Chrome settings have been cleared and operation is completed. Provide an empty value ("") to avoid executing this campaign

Outputs

Label Type Description
Cleared Chrome Settings StringList List of cleaned settings

Test Scenarios

ClearOfBrowsingHistory
Test Case Total cleanup of the browser's history
Environment Windows 10, Windows 11
Results Success - The BrowsingHistory is successfully cleared on the target device
ClearOfCache
Test Case Clear the cache of Chrome
Environment Windows 10, Windows 11
Results Success - The Cache is successfully cleared on the target device
ClearOfCookies
Test Case Clear the cache of Chrome
Environment Windows 10, Windows 11
Results Success - The Cookies are successfully cleared on the target device
ClearOfBrowsingHistory
Test Case Total cleanup of the browser's history
Environment 10.15, 11, 12, 13
Results Success - The BrowsingHistory is successfully cleared on the target device
ClearOfCache
Test Case Clear the cache of Chrome
Environment 10.15, 11, 12, 13
Results Success - The Cache is successfully cleared on the target device
ClearOfCookies
Test Case Clear the cache of Chrome
Environment 10.15, 11, 12, 13
Results Success - The Cookies are successfully cleared on the target device

Disable Application from Startup menu

Script Description

Disables startup of every application from ApplicationsToDisable parameter, excluding all listed in ApplicationsToKeep parameter.If all applications should be disabled except specific ones, use only ApplicationsToKeep as a white-list and leave ApplicationsToDisable empty ().If only some specific applications should be disabled, use only ApplicationsToDisable and leave ApplicationsToKeep empty ().If an application is present in both parameters, ApplicationsToKeep takes precedence and the application will not be removed from Startup.

Warning: End-users could rely on the auto-start of applications that this Remote Action disables. Please perform appropriate testing before release.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed manually.

A timeout of 500 seconds is recommended.

Parameters

Label Description
Applications To Keep Comma-separated list of programs to be kept on the Startup. Name has to be exactly as the processes' name (e.g. Lync, vmware-tray.exe)
Applications To Disable Comma-separated list of programs to be disabled on the Startup. Name has to be exactly as the processes' name (e.g. Lync, vmware-tray.exe)
Action Action to be taken with the programs to disable registry keys. Value should be 'Delete' for erasing the applications from the Startup menu and 'Disable' to keep them disabled

Outputs

None.

Restrictions

Further Information

In order to get the exact names for the input parameters, you can use Get Startup Impact Remote Action to get the list of startup applications

You may also want to check the following registry keys for local machine (HKLM) and logged user (HKU\<sid> or HKCU):
* '\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\StartupApproved\Run'
* '\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\StartupApproved\Run32'
* '\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\StartupApproved\StartupFolder'
* '\SOFTWARE\Microsoft\Windows\CurrentVersion\Run'
* '\SOFTWARE\Microsoft\Windows\CurrentVersion\RunOnce'
* '\SOFTWARE\WOW6432Node\Microsoft\Windows\CurrentVersion\Run'
* '\SOFTWARE\WOW6432Node\Microsoft\Windows\CurrentVersion\RunOnce'
You can use Get Windows Registry Key Values remote Action to get this information.

Test Scenarios

ApplicationsToKeep
Test Case ApplicationsToKeep input parameter is provided.
ApplicationsToDisable is not provided (empty).
Action is 'Disable'.
Environment Windows 10 (1803/1809/1903) x86/x64 - EN/ES
Results Success - Applications present in ApplicationsToKeep were not disabled from startup. The rest of the applications were disabled from startup.
ApplicationsToDisable
Test Case ApplicationsToDisable input parameter is provided.
ApplicationsToKeep is not provided (empty).
Action is 'Disable'.
Environment Windows 10 (1803/1809/1903) x86/x64 - EN/ES
Results Success - Applications present in ApplicationsToDisable were disabled from startup. The rest of the applications were not affected.
ApplicationsToDelete
Test Case ApplicationsToDisable input parameter is provided.
ApplicationsToKeep is not provided (empty).
Action is 'Delete'.
Environment Windows 10 (1803/1809/1903) x86/x64 - EN/ES
Results Success - Applications present in ApplicationsToDisable were disabled and removed from Task Manager's Startup tab. The rest of the applications were not affected.
ApplicationsToKeepAndToDisable
Test Case Both ApplicationsToKeep and ApplicationsToDisable input parameters were provided.
Action is 'Disable'.
Environment Windows 10 (1803/1809/1903) x86/x64 - EN/ES
Results Success - Applications present in ApplicationsToKeep were not disabled from startup.
Applications present in ApplicationsToDisable were disabled from startup.
The rest of the applications were not affected.
ApplicationInBothParameters
Test Case Both ApplicationsToKeep and ApplicationsToDisable input parameters were provided.
There is an application that is present in both input parameters.
Action is 'Disable'.
Environment Windows 10 (1803/1809/1903) x86/x64 - EN/ES
Results Success - ApplicationsToKeep takes preference. Therefore, all applications in ApplicationsToDisable were disabled from startup except the application present in both lists.
EmptyApplicationLists
Test Case Both lists of applications to keep and to disable were empty.
Environment Windows 10 (1803/1809/1903) x86/x64 - EN/ES
Results Failure - The remote action execution failed, since at least one of the input parameters must be provided.

Invoke recycle bin cleanup

Script Description

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.

The Remote Action checks the recycle bins from all logical drives and determines the size of the files inside.

A cleanup is then performed based on the input parameters 'settings' that you supplied to the Remote Action.

'Warning' the cleanup operation permanently deletes recycle bin data that meets the criteria specified in the input, from all targeted devices.

Execution context and suggested scheduling

Run the script as 'interactive user'. The script should be executed manually.

A timeout of 1200 seconds is recommended.

Parameters

Label Description
Bin Size in MB 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
campaign id 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
operation completed 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

Outputs

Label Type Description
recycle bin size Size The amount of data that we managed to clear from the recycle bin
deletion done Bool 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'