Nexthink Recognized by SIIA as the Best Digital Employee Experience Platform Learn more

Learn more

Learn more

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

MS Teams: Management

Back

MS Teams: Management

Latest Version: 3.0.0.0
|
Updated on April 12, 2024
Install
Configuration

Description

Set of Microsoft Teams related Remote Actions to examine errors, warnings, performance troubleshoot and fix issues.

Versions

  • 3.0.0.0 - 12 Apr 2024 - Added "Get Microsoft Teams client status" Remote Action
  • 2.4.2.1 - 13 Jun 2023 - Fixed outputs in "Set Teams GPU hardware acceleration" for Windows
  • 2.4.2.0 - Added remote action "Set Teams GPU hardware acceleration" for both Windows and macOS
  • 2.4.1.0 - 08 Feb 2023 - Updated OS requirements
  • 2.4.0.0 - 22 Jul 2022 - Updated "Invoke Network Assessment Tool" Remote Action to support Microsoft Teams Network Assessment Tool
  • 2.3.0.0 - 22 Oct 2021 - Improved error handling on "Clear Teams cache" Remote Action
  • 2.2.0.0 - 04 Oct 2021 - Updated "Reinstall Microsoft Teams macOS" Remote Action to download and install the latest version of Microsoft Teams
  • 2.1.0.0 - 17 Sep 2021 - Updated the code up to our conventions and fixed a bug related to the comma parsing on different cultures for "Invoke Network Assessment Tool" Remote Action
  • 2.0.0.1 - 24 Aug 2021 - Fixed minor bug in "Clear Microsoft Teams Cache" remote action
  • 2.0.0.0 - 23 Aug 2021 - Added remote action "Reinstall Microsoft Teams macOS" and added macOS support for "Clear Microsoft Teams Cache" Remote Action
  • 1.2.0.0 - 19 Aug 2021 - Renamed "Reinstall Microsoft Teams" to "Reinstall Microsoft Teams Windows" Remote Action
  • 1.1.0.0 - 30 Jul 2021 - Updated "Reinstall Microsoft Teams" Remote Action description
  • 1.0.1.1 - 11 Jan 2021 - Modified campaign message in "Clear Microsoft Teams Cache" Remote Action
  • 1.0.1.0 - 20 Oct 2020 - Fixed "Clear Microsoft Teams Cache" Remote Action documentation
  • 1.0.0.0 - 19 Oct 2020 - Initial release

Required Products

Nexthink Act
Nexthink Engage

Platforms

Windows 7 and newer
MacOS Catalina and newer

Compatibility

V6.14 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 Microsoft Teams client status

Script Description

Please note that this Remote Action is only supported on the Teams version 'Microsoft Teams Classic'.

This Remote Action helps organizations gain deeper visibility into their Microsoft Teams endpoint compliance state.We make it possible to understand any occurrences where Microsoft Teams is not installed on a device, and where Teams is installed we give insights into the number of months since Microsoft was updated. In scenarios where Teams is missing or out of date, it is possible to use the accompanying Remote Action 'Reinstall Microsoft Teams' to install the latest version of Teams.

Additionally the Remote Action outputs the current setting of Teams GPU Hardware Acceleration. If you wish to change the GPU Hardware Acceleration mode this is possible using the Remote Action 'Set MS Teams GPU hardware acceleration'

Please note that the 'number of months since last updated' functionality of this Remote Action is only supported on Operating Systems which use the Gregorian date format.

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
teams installed Bool Is the Teams client installed on the device
teams version String The version of the installed Teams client
months since last update Int The number of months since Teams client was updated
teams gpu acceleration disabled Bool Is GPU acceleration setting is disabled

Further Information

This Remote Action is currently only supported on the Microsoft Teams version 'Classic'.

Test Scenarios

TeamsIsInstalled
Test Case All outputs are available
Environment Windows 10 - Windows 11
Results Success - Outputs are available
TeamsIsNotInstalled
Test Case Some outputs are not available
Environment Windows 10 - Windows 11
Results Success - Outputs are not available
TeamsIsInstalled
Test Case All outputs are available
Environment macOS 10.15, 11, 12, 13
Results Success - Outputs are available
TeamsIsNotInstalled
Test Case Some outputs are not available
Environment macOS 10.15, 11, 12, 13
Results Success - Outputs are not available

Invoke Network Assessment Tool

Script Description

Using Microsoft Teams Network Assessment Tool connects to nearby Microsoft node to test voice call quality (round trip time, jitter, packet loss rate).Results are calculated based on 90 percentile of values per metric.Tool is applicable for quality test of Microsoft Teams.

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 overloading server hosting virtual machines. Provide number of seconds less than 600

Outputs

Label Type Description
RTT Latency Float Round trip time latency between device and Microsoft server node
Jitter Float Average time difference of packet arrival
Packet Loss Rate Ratio Fraction of the total transmitted packets that did not arrive at the receiver

Restrictions

Further Information

Microsoft Teams Network Assessment Tool can be downloaded from here.

Get Teams Info

Script Description

Please note that this Remote Action is only supported on the Teams version 'Microsoft Teams Classic'.

Shows the login errors of the last 24h, the deployment ring, network errors and calls made using Microsoft Teams classic.

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

None.

Outputs

Label Type Description
Authentication Errors Bool Checks if a authentication error has ocurred in the last 24h
Deployment Ring String Name of the deployment ring the Microsoft Teams user is part of
Network Access Denied Bool Checks if a network access error has ocurred in the last 24h
Calls Int Total number of calls initiated in the last 24h

Further Information

The data returned by this Remote Action relies on Microsoft Teams classic log files. The information may be inaccurate if the log message formatting has changed.

The following scenarios will be added to the "Calls" output:
- Meetings.
- Every time you join a call (even if you join multiple times the same meeting).
- Unanswered outgoing calls.
- Invitations to an ongoing call.
- The "Meet now" feature.

The following scenarios will not be added to the "Calls" output:
- Unanswered incoming calls.

Test Scenarios

AuthenticationErrorsDuringLastDay
Test Case There was at least one authentication error during the last 24 hours
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - 'AuthenticationErrors' output is "true"
NetworkAccessDeniedLastDay
Test Case There was at least one network access denied error during the last 24 hours
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - 'NetworkAccessDenied' output is "true"
CallsDuringLastDay
Test Case There were calls correctly established during the last 24 hours
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - 'Calls' output displayed the total number of calls done successfully during the last day
DeploymentRingInfoObtained
Test Case The information about the Microsoft Teams product deployment ring is obtained
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - 'DeploymentRing' output displayed the current deployment ring
DeploymentRingInfoNotAvailable
Test Case The information about the Microsoft Teams product deployment ring could not be obtained or was not available
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - 'DeploymentRing' output is empty ("-") since the information was not available, adn a warning is displayed, indicating that the ring information could not be obtained
NothingRelevantDuringLastDay
Test Case Nothing was found during the last 24 hours
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - All the outputs will have default values ("false", "-" or 0)
BigLogFileAnalyzed
Test Case A file with 30.000 lines for the last 24 hours was analyzed
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - The script behaves accordingly, without causing any CPU/Memory peaks nor resource consumption warnings on Finder
MicrosoftTeamsNotInstalled
Test Case The Microsoft Teams product is not installed on target device
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Failure - Outputs will display default values ("false", "-" or 0) and a warning will be shown, indicating that Microsoft Teams is not installed

Reinstall Microsoft Teams macOS

Script Description

Reinstalls Microsoft Teams to avoid version disparity, broken installed versions or simply because you want the new features offered in new versions.

Warning: This Remote Action simultaneously downloads and installs the latest version of Microsoft Teams on all targeted devices. Please ensure that the available network capacity is appropriate for the number of targeted devices.

Execution context and suggested scheduling

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

A timeout of 900 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
Campaign Id ID of the campaign to notify user that Microsoft Teams must be closed for the reinstallation. 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 Microsoft Teams reinstallation process. Provide an empty ID to avoid executing this campaign

Outputs

None.

Clear Microsoft Teams Cache

Script Description

Please note that this Remote Action is only supported on the Teams version 'Microsoft Teams Classic'.

Closes Microsoft Teams if it is open and deletes the cache files. Can be used for troubleshooting purposes on devices facing issues with Microsoft Teams.

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
Campaign Id ID of the campaign to notify user that Microsoft Teams must be closed for the cache cleaning. Provide an empty value to avoid executing this campaign
Operation Completed Campaign Id ID of the campaign to notify the user about the finish of the Microsoft Teams cache cleaning. Provide an empty value to avoid executing this campaign

Outputs

None.

Test Scenarios

NoLocationIsPresent
Test Case Microsoft Teams locations are not present on the device
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Failure - Message about no location has been found
UserRejectedToCloseTeams
Test Case User answered "Close later" in the campaign
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Failure - Is was impossible to close Microsoft Teams so the cleaning cannot be performed
CleaningPerformedWhenUsingCampaigns
Test Case Teams is opened and the user answered "Close now" in the campaign
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - Teams is closed automatically and the cache is cleaned
CleaningPerformedWhenTeamsOpenedAndNoCampaigns
Test Case Teams is opened and no campaigns are configured
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - Teams is closed automatically without any notice and the cache is cleaned. No campaign is shown
NoTeamsInstallIsPresent
Test Case Microsoft Teams is not installed on the device
Environment OSX Mojave 10.14.6 EN
Results Failure - Message Microsoft Teams is not installed
UserRejectedToCloseTeams
Test Case User answered "Close later" in the campaign
Environment OSX Mojave 10.14.6 EN
Results Failure - Is was impossible to close Microsoft Teams so the cleaning cannot be performed
CleaningPerformedWhenUsingCampaigns
Test Case Teams is opened and the user answered "Close now" in the campaign
Environment OSX Mojave 10.14.6 EN
Results Success - Teams is closed automatically and the cache is cleaned
CleaningPerformedWhenTeamsOpenedAndNoCampaigns
Test Case Teams is opened and no campaigns are configured
Environment OSX Mojave 10.14.6 EN
Results Success - Teams is closed automatically without any notice and the cache is cleaned

Reinstall Microsoft Teams Windows

Script Description

Please note that this Remote Action is only supported on the Teams version 'Microsoft Teams Classic'.

Reinstalls Microsoft Teams to avoid version disparity, broken installed versions or simply because you want the new features offered in new versions.Warning: This Remote Action simultaneously downloads and installs the latest version of Microsoft Teams on all targeted devices. Please ensure that the available network capacity is appropriate for the number of targeted devices.

Execution context and suggested scheduling

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

A timeout of 900 seconds is recommended.

Parameters

Label Description
Campaign Id ID of the campaign to notify user that Microsoft Teams must be closed for the reinstallation
Operation Completed Campaign Id ID of the campaign to notify the user about the finish of the Microsoft Teams reinstallation process
Maximum Delay In Seconds Maximum random delay set to avoid overloading the network. Provide number of seconds less than 600

Outputs

None.

Further Information

This Remote Action ensures secure HTTPS connections through TLS by leveraging ::CheckCertificateRevocationList while using System.Net.WebClient .NET Framework Class, which by default allows connections to sites with their certificate revoked.

Test Scenarios

TeamsIsNotInstalled
Test Case No version of Microsoft Teams is installed.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - Last version of Teams is installed silently.
TeamsIsInstalledSilently
Test Case Microsoft Teams is installed and not running.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - Last version of Teams is installed silently.
AllCampaignsAreCalled
Test Case Microsoft Teams is installed and running.
First campaign GUID has the default value.
Second campaign GUID has the default value.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - Last version of Teams is installed and all campaigns are called correctly.
OnlyFirstCampaignIsCalled
Test Case Microsoft Teams is installed and running.
First campaign GUID has the default value.
Second campaign GUID is empty.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - Last version of Teams is installed and the first campaign is called correctly.
OnlySecondCampaignIsCalled
Test Case Microsoft Teams is installed and running.
First campaign GUID is empty.
Second campaign GUID has the default value.
Environment VM Windows 7 x64 (Multi-language) - VM Windows 10 x86/x64 (Multi-language) (1803/1809/1903)
Results Success - Last version of Teams is installed and the second campaign is called correctly.

Set Teams GPU Hardware Acceleration

Script Description

Please note that this Remote Action is only supported on the Teams version 'Microsoft Teams Classic'.

Disable or enable the GPU hardware acceleration on Microsoft Teams, helping to improve the performance.

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
Close Teams Campaign Id ID of the campaign to notify the user that MS Teams will be closed to do the changes
Operation Completed Campaign Id ID of the campaign to notify the user that MS Teams can be opened again
Status Parameter to change the GPU acceleration, could be enable or disable

Outputs

None.

Further Information

This Remote Action is currently only supported on the Microsoft Teams version 'Classic'.

Test Scenarios

TeamsIsInstalled
Test Case Check if Teams is installed
Environment Windows 10, Windows 11
Results Success - Teams is installed in target computer
JsonFileExists
Test Case Check if desktop-config.json file exists in the computer
Environment Windows 10, Windows 11
Results Success - File is reachable in the target computer
JsonFileCanBeWritten
Test Case Check if desktop-config.json file can be written in the computer
Environment Windows 10, Windows 11
Results Success - File can be written
TeamsIsInstalled
Test Case Check if Teams is installed
Environment VM macOS 10.15, 11, 12, 13
Results Success - Teams is installed in target computer
JsonFileExists
Test Case Check if desktop-config.json file exists in the computer
Environment VM macOS 10.15, 11, 12, 13
Results Success - File is reachable in the target computer
JsonFileCanBeWritten
Test Case Check if desktop-config.json file can be written in the computer
Environment VM macOS 10.15, 11, 12, 13
Results Success - File can be written