You are using an ad blocker that is interfering with our web typography and internal javascript. Please whitelist our domain to live in a more beautiful world. No ads here, just really great software!

Experience Everywhere On-Demand: Learn how Global 2000 firms are approaching Digital Employee Experience in 2021. Get Access

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

OneDrive – Management

Latest Version: 1.0.0.0
Install
Configuration

Required Products

Nexthink Act

Platforms

Windows

Compatibility

V6.20 and later

Description

This pack provides you with Remote Actions that allow you to retrieve various types of information pertaining to the status of OneDrive clients on all the devices within your IT environment.Below is a list of the Remote Actions included in this pack and a brief description of their capability:

  • Get MS Office information: Obtains the size of the OneDrive folder on the local disk.
  • Get OneDrive information: Calculates the space used by OneDrive.
  • Checks the status of the OneDrive application.
  • Get OneDrive Sync Status: Gathers OneDrive sync status from OneDrive logs.
  • Test OneDrive Files Path and Syntax: Tests if the files in a given path are compatible for OneDrive migration.
  • Repair OneDrive: Repairs or Reinstalls OneDrive.
  • Set OneDrive Configuration: Configures registry keys responsible for "SilentAccountConfig", "Files On Demand", and "Update Ring" features of Microsoft OneDrive.

Versions

  • 1.0.0.0 - 03 Feb 2021 - Initial release

Get MS Office information

Script Description

Returns several Microsoft Office-related information, such as the version of the suite, the applications installed, the language preferences, the size of the user's Outlook Data Files and the used space in the OneDrive business account folder.Useful for troubleshooting both Office-related and disk space issues and for managing the Office migration to the cloud. The script is developed for Windows 10 and 7 and Microsoft Office 2010 onwards.

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

None.

Outputs

Label Type Description
MS Office Version StringList Version of the Microsoft Office suite installed on the device
Installed Applications StringList List of installed Office applications
Active Display Language StringList Display language currently in use
Installed Display Languages StringList List of display languages installed on the device
Installed Editing Languages StringList List of editing languages installed on the device
Number Of PST Files Int Number of .PST files stored on the device
Number Of OST Files Int Number of .OST files stored on the device
PST Overall size Size Size of the .PST file, or sum of all .PST files' sizes
OST Overall size Size Size of the .OST file, or sum of all .OST files' sizes
One Drive Sync Files Size Size Size on the disk of the OneDrive folder
Other One Drive Sync Files Size Size Size on the disk of all other data locally synchronized through OneDrive agent

Further Information

Limited support for Click to Run deployments. Installed applications and language-related information cannot be retrieved.

Test OneDrive Files Path and Syntax

Script Description

Tests if the files meet all the OneDrive specifications (size, name, path length, etc..) so a migration won't have any conflicts.

Execution context and suggested scheduling

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

A timeout of 10020 seconds is recommended.

Parameters

Label Description
Migration Path Full path of the folder to be checked
Maximum Delay In Seconds Maximum random delay set to avoid overloading server hosting virtual machines. Provide number of seconds less than 600

Outputs

Label Type Description
Migration Readiness Bool If provided input migration path is ready for OneDrive
Invalid Characters Int Number of detected files with invalid characters in name
Invalid Names Int Number of detected files/folders with invalid names
Invalid Path Lengths Int Number of files/folders with path longer than accepted
Reparse Points Int Number of detected folders as symbolic links or junction points
Invalid Sizes Int Number of detected files with greater size than allowed
One Note Files Int Number of detected one note files

Further Information

Depending on the input path, this script can have a significant performance impact. Use on small folder structures only!
Parameter 'MaximumDelayInSeconds' 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.
Script uses all available CPU on Windows 7 and approximately 15% CPU on Windows 10.

Test Scenarios

PathContainsCorrectFiles
Test Case The path provided contains a number of files that are compatible for the migration.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - The files are analyzed and all the files were found compatible so the MigrationReadiness is set to True.
PathContainsIncorrectFiles
Test Case The path provided contains a number of files and some of them are not compatible.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - The files are analyzed and some of the fields have an output different from zero indicating that there are some files not compatible with the migration.

Get OneDrive Sync Status

Script Description

Gathers OneDrive sync status from the business accounts SyncDiagnostics.log.

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

None.

Outputs

Label Type Description
Sync Progress State String Status of the sync process
Timestamp DateTime Timestamp when the log was written for the last time
To Download Size Total amount of size pending to download
To Upload Size Total amount of size pending to upload
Files To Download Int Number of files pending to download
Files To Upload Int Number of files pending to upload
Changes To Process Int Number of changes pending to process
Changes To Send Int Number of changes pending to send
Download Speed BitRate Download speed
Upload Speed BitRate Upload speed
Estimated Time Remaining Millisecond Estimated time remaining to finish the sync process
Office Sync Active Bool Whether Microsoft Office sync is active on the device
Office Sync Enabled Bool Whether Microsoft Office sync is enabled on the device
File Failed Upload Count Int Number of failing uploads
File In Warning Count Int Number of warnings during the sync process

Restrictions

Test Scenarios

PersonalAccountsNotAllowed
Test Case The user has only a personal account in OneDrive
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Failure - Only business account are allowed
LogMissing
Test Case The log is not present in the expected folder
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Failure - The log must be present to gather the information
InformationGathered
Test Case The log is present with the expected data
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - The output fields are filled with the information from the log file

Set OneDrive Configuration

Script Description

Configures Microsoft OneDrive policy settings of SilentAccountConfig to automatically configure user account instead of having to provide credentials manually, FilesOnDemand to enable online access to files stored with the service, and UpdateRing to define in which update process the device should be.

Execution context and suggested scheduling

Run the script as 'local system'. The script should be executed every 1 week.

A timeout of 120 seconds is recommended.

Parameters

Label Description
Silent Account Config Parameter responsible for OneDrive user account configuration, which hides initial popup window that asks to provide credentials. Accepted values are (Disabled/Enabled). In case of filling the input with an empty value (""), the configuration will not be enforced
Files On Demand Parameter manages online access to files that allows saving up space. Accepted values are (Disabled/Enabled). In case of filling the input with an empty value (""), the configuration will not be enforced
Update Ring Parameter manages the OneDrive update process that will apply to target device. Accepted values are (Production/Enterprise/Insiders). In case of filling the input with an empty value (""), the configuration will not be enforced

Outputs

None.

Further Information

Group Policy dedicated to mentioned features will overwrite changes applied by this script.
More information on Silent Account Config can be found here.
More information on Files on Demand can be found here.
More information about OneDrive Update Rings can be found here.

Test Scenarios

SuccessfulExecution
Test Case All inputs are filled with accepted values.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - The desire configuration is set in the device.
SilentAccountConfigIsIncorrect
Test Case The SilentAccountConfig input contains a not empty value other than "Enabled" or "Disabled"
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Failure - Accepted values are (Disabled/Enabled)
FilesOnDemandIsIncorrect
Test Case The FilesOnDemand input contains a not empty value other than "Enabled" or "Disabled"
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Failure - Accepted values are (Disabled/Enabled)
UpdateRingIsIncorrect
Test Case The UpdateRing input contains a not empty value other than "Production", "Enterprise" or "Insiders"
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Failure - Accepted values are (Production/Enterprise/Insiders)

Get OneDrive Information

Script Description

Calculates the size of the Business and Personal OneDrive tenant folders, and retrieves currently configured OneDrive Update Ring. Tenants in Business accounts starting with 'OneDrive - ` will be included in the Business output, whereas any other will be treated as SharedLibraries.

Execution context and suggested scheduling

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

A timeout of 1320 seconds is recommended.

Parameters

Label Description
Maximum Delay In Seconds Maximum random delay set to avoid overloading server hosting virtual machines. Provide number of seconds less than 600

Outputs

Label Type Description
Total Cloud Size Business Size Size of the OneDrive Business main tenant folder on the cloud
Total Local Size Business Size Size of the OneDrive Business main tenant folder on the disk
Size of the OneDrive Business tenant folders (other than main tenant) on the cloud Size Size of additional OneDrive folders
Total Local Size Shared Libraries Size Size of the OneDrive Business tenant folders (other than main tenant) on the disk
Total Cloud Size Personal Size Size of the OneDrive Personal tenant folders on the cloud
Total Local Size Personal Size Size of the OneDrive Personal tenant folders on the disk
One Drive Update Ring String Currently configured OneDrive Update Ring. For more information visit this link

Further Information

Size is calculated based on the size of the file, does not consider memory allocation on the local disk (Size on Disk) which is always presented as greater value and may vary.

Test Scenarios

OneDriveBusinessAccountConfigured
Test Case The device has a Business OneDrive folder with some Shared Libraries synced.
Environment Windows 10 x64 (1809)
Results Success - Folder content size was correctly returned with respective output parameters.
OneDriveNotInstalled
Test Case The device does not have a Business OneDrive installed.
Environment Windows 10 x64 (1809)
Results Failure - Exception is thrown reporting OneDrive accounts registry key is not accessible.
OneDriveAccountNotConfigured
Test Case The device does not have a Business OneDrive configured, or does not have any data.
Environment Windows 10 x64 (1809)
Results Success - Script completed successfully and returned zero bytes as output values.
OneDriveUpdateRingConfigured
Test Case The device is configured with specific OneDrive Update Ring.
Environment Windows 10 x64 (1809)
Results Success - Script completed successfully and returned current OneDrive Update Ring.
OneDriveUpdateRingNotConfigured
Test Case The device is not configured with OneDrive Update Ring.
Environment Windows 10 x64 (1809)
Results Success - Script completed successfully and reported message OneDrive Update Ring registry is not accessible.

Repair OneDrive

Script Description

Performs a OneDrive repair or reinstallation on the device, mitigating possible sync issues.

Execution context and suggested scheduling

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 1080 seconds is recommended.

Parameters

Label Description
Maximum Delay In Seconds Maximum random delay set to avoid overloading server hosting virtual machines. Provide number of seconds less than 600
Action Action to be performed on OneDrive. Possible values are Repair or ReInstall

Outputs

None.

Restrictions

Further Information

When sync issues happen, it is enough with a repair of the OneDrive application. To perform it, current interactive user must be selected.
Repair action may delete all not synchronized files from OneDrive folder, please, back them up before executing the remote action.
Some problems need a complete reinstallation of the OneDrive application, or when devices have different and out-of-date versions installed. To fix this, the script downloads and installs the latest compliant version of OneDrive. Local system must be selected.
Reinstall action does not remove local files and a synchronization is executed after the process.
No popups are shown to the user as OneDrive reinstallation is executed in a silent mode.

Test Scenarios

ReinstallProvided
Test Case Reinstall is provided as action.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - No errors related to this input parameter.
RepairProvided
Test Case Repair is provided as action.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - No errors related to this input parameter.
InvalidValueProvided
Test Case An invalid value is provided as action.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Failure - Error in parameter validation.
OneDriveInstalledInUserFolder
Test Case OneDrive is installed in the user folder.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - The installation is detected.
OneDriveInstalledInProgramFilesFolder
Test Case OneDrive is installed in the program files folder.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - The installation is detected.
OneDriveIsNotInstalled
Test Case OneDrive is not installed on the device.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Failure - The application must be installed previously.
OneDriveInUserFolderIsRepaired
Test Case OneDrive is installed in the user folder and repair is passed as action.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - It is repaired properly.
OneDriveInProgramFilesFolderIsRepaired
Test Case OneDrive is installed in the program files folder and repair is passed as action.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - It is repaired properly.
OneDriveInUserFolderIsReinstalled
Test Case OneDrive is installed in the user folder and reinstall is passed as action.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - It is reinstalled properly.
OneDriveInProgramFilesFolderIsReinstalled
Test Case OneDrive is installed in the program files folder and reinstall is passed as action.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - It is reinstalled properly.

Get OneDrive Status

Script Description

Checks if the OneDrive application is working properly by reviewing some processes status, registry keys and environment variables.

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

None.

Outputs

Label Type Description
One Drive Status StringList Overall result of the OneDrive health status review

Further Information

Complete list of performed validations:
* %localappdata%\Microsoft\OneDrive\OneDrive.exe exists.
* OneDrive.exe is running.
* %OneDrive% environment variable exists.
* Review the key HKEY_CURRENT_USER\Software\Microsoft\OneDrive\Accounts\Business1\UserFolder to check if that folder was created on devices.

If some validation fails, it means that OneDrive is not working properly. Further investigation is required, but a reinstall might be necessary.

Thank you!