Installing required Cayosoft Administrator components

Content:

Overview

Cayosoft Administrator requires dependencies to be installed in order to connect to target platforms and process data. This article lists the required and optional components and ways to install them to ensure the correct operation of Cayosoft Administrator in your environment.

List of dependencies

Refer to the following list of dependencies:

Required: Windows Management Framework (WMF).
Required: PowerShell Gallery module (PowerShellGet).
Optional, required for Active Directory management: Active Directory module for PowerShell.
Optional, required for Microsoft 365 management: Exchange Online PowerShell module.
Optional, required for Microsoft Teams management: Microsoft Teams PowerShell Module.
Optional, required for SharePoint Online management: SharePoint Client-Side Object Model.
Optional, required for SharePoint Online management: SharePoint Online Management Shell.

For additional information about versions of components used in each Cayosoft Administrator release, see the following article: Required modules for Administrator Service.

Installing components

This section lists steps to install the dependencies in two ways:

Using the Cayosoft Requirements Check tool. The tool in included in the Cayosoft Administrator installation.
Manually with individual steps specified for each dependency.

Installing components using Requirements Check tool

The Cayosoft Requirements Check tool is included in the Cayosoft Administrator installation. Refer to the following steps to review the installed components and install the missing required components using the tool:

In the Start menu, navigate to Cayo Software > Cayosoft Requirements Check. Alternatively, navigate to the installation folder and run the Cayo.CheckPreRequisites application. The default path to the installation folder is C:\Program Files\Cayo Software\AdminAssistant.
Review the components and descriptions. If some component is not installed on the server, the Click here to install button is prompted to the right.
Install the required modules by clicking the corresponding install buttons. When prompted to confirm the Cayosoft Administrator Service and console should be stopped, click OK to continue.
After you install the required components, close the tool and reopen the Cayosoft Administrator console.

IMPORTANT: If you encounter the Failed to connect to Administration Service error when you reopen the console, navigate to Services and start the Cayosoft Administrator Service.

Installing components manually

If you would like to prepare the environment for Cayosoft Administrator beforehand, you can install the components manually without using the Requirements Check tool. Refer to the following section for dedicated steps to install specific components.

Windows Management Framework v5.1

PowerShell Gallery module

Expand the element to learn more about the steps to manually install the module. Collapse the element to hide the steps.

Refer to the following steps to install the component:

Run an elevated instance of PowerShell ISE—right-click the shortcut and select Run as administrator.
If you have already installed Cayosoft Administrator, stop the Cayosoft Administrator Service. Run the following line in the console:
Copy
```
Stop-Service CayoAdminService
```
Run the following line to check your current PowerShell Gallery module version:
Copy
```
Get-Module PowerShellGet -ListAvailable
```
Perform further steps based on the output of the line.
- If the line did not return any output, install the module. Run the following line:
  Copy
```
Install-Module PowerShellGet -Confirm:$False -Scope AllUsers -RequiredVersion %ModuleVersion%
```
  Cayosoft Administrator implements specific modules depending on the build version—replace the placeholder with the correct module version as per the following article: Required modules for Administrator Service.
- If the line returned a different version, remove the currently installed version and install the required one. Run the following lines:
  Copy
```
Uninstall-Module PowerShellGet -Confirm:$False -AllVersions
Install-Module PowerShellGet -Confirm:$False -Scope AllUsers -RequiredVersion %ModuleVersion%
```
  Replace the placeholder with the target module version as per the following article: Required modules for Administrator Service.
Start the Cayosoft Administrator Service. Run the following line in the console:
Copy
```
Start-Service CayoAdminService
```

Active Directory module for Windows PowerShell (RSAT)

Expand the element to learn more about the steps to manually install the module. Collapse the element to hide the steps.

The Remote Server Administration Tools for Windows (RSAT) component is required by Cayosoft Administrator to connect to and use Active Directory as a source system for various administrative tasks. When you install Cayosoft Administrator on a server with Windows Server OS, add the Active Directory Module for Windows Powershell feature in the Remote Server Administration Tools feature group via Server Manager.

Alternatively, add the feature via PowerShell. Refer to the following steps:

Run an elevated instance of PowerShell ISE—right-click the shortcut and select Run as administrator.
If you have already installed Cayosoft Administrator, stop the Cayosoft Administrator Service. Run the following line in the console:
Copy
```
Stop-Service CayoAdminService
```
Run the following line to install the Active Directory Module for Windows Powershell feature:
Copy
```
Install-WindowsFeature RSAT-AD-PowerShell
```
Start the Cayosoft Administrator Service. Run the following line in the console:
Copy
```
Start-Service CayoAdminService
```

NOTE: Refer to the following article for steps on installing the RSAT feature on Windows OS workstations: Remote Server Administration Tools (RSAT) for Windows | Windows Learn.

Exchange Online PowerShell module

Expand the element to learn more about the steps to manually install the module. Collapse the element to hide the steps.

Refer to the following steps to install the component:

Run an elevated instance of PowerShell ISE—right-click the shortcut and select Run as administrator.
If you have already installed Cayosoft Administrator, stop the Cayosoft Administrator Service. Run the following line in the console:
Copy
```
Stop-Service CayoAdminService
```
Run the following line to check your current Exchange Online module version:
Copy
```
Get-Module ExchangeOnlineManagement -ListAvailable
```
Perform further steps based on the output of the line.
- If the line did not return any output, install the module. Run the following line:
  Copy
```
Install-Module ExchangeOnlineManagement -Confirm:$False -Scope AllUsers -RequiredVersion %ModuleVersion%
```
  Cayosoft Administrator implements specific modules depending on the build version—replace the placeholder with the correct module version as per the following article: Required modules for Administrator Service.
- If the line returned a different version, remove the currently installed version and install the required one. Run the following lines:
  Copy
```
Uninstall-Module ExchangeOnlineManagement -Confirm:$False -AllVersions
Install-Module ExchangeOnlineManagement -Confirm:$False -Scope AllUsers -RequiredVersion %ModuleVersion%
```
  Replace the placeholder with the target module version as per the following article: Required modules for Administrator Service.
Start the Cayosoft Administrator Service. Run the following line in the console:
Copy
```
Start-Service CayoAdminService
```

Teams PowerShell module

Expand the element to learn more about the steps to manually install the module. Collapse the element to hide the steps.

Refer to the following steps to install the component:

Run an elevated instance of PowerShell ISE—right-click the shortcut and select Run as administrator.
If you have already installed Cayosoft Administrator, stop the Cayosoft Administrator Service. Run the following line in the console:
Copy
```
Stop-Service CayoAdminService
```
Run the following line to check your current Exchange Online module version:
Copy
```
Get-Module MicrosoftTeams -ListAvailable
```
Perform further steps based on the output of the line.
- If the line did not return any output, install the module. Run the following line:
  Copy
```
Install-Module MicrosoftTeams -Confirm:$False -Scope AllUsers -RequiredVersion %ModuleVersion%
```
  Cayosoft Administrator implements specific modules depending on the build version—replace the placeholder with the correct module version as per the following article: Required modules for Administrator Service.
- If the line returned a different version, remove the currently installed version and install the required one. Run the following lines:
  Copy
```
Uninstall-Module MicrosoftTeams -Confirm:$False -AllVersions
Install-Module MicrosoftTeams -Confirm:$False -Scope AllUsers -RequiredVersion %ModuleVersion%
```
  Replace the placeholder with the target module version as per the following article: Required modules for Administrator Service.
Start the Cayosoft Administrator Service. Run the following line in the console:
Copy
```
Start-Service CayoAdminService
```

SharePoint Client-Side Object Model module

Expand the element to learn more about the steps to manually install the module. Collapse the element to hide the steps.

Refer to the following steps to install the component:

Run an elevated instance of PowerShell ISE—right-click the shortcut and select Run as administrator.
If you have already installed Cayosoft Administrator, stop the Cayosoft Administrator Service. Run the following line in the console:
Copy
```
Stop-Service CayoAdminService
```

Set the security protocol:

Copy

[Net.ServicePointManager]::SecurityProtocol=[Net.SecurityProtocolType]::Tls12 -bor [Net.SecurityProtocolType]::Ssl3

Run the following line to check your current CSOM package version:
Copy
```
Get-Package -Name Microsoft.SharePointOnline.CSOM
```
Perform further steps based on the output of the line.
- If the line did not return any output, install the module. Run the following line:
  Copy
```
Install-Package Microsoft.SharePointOnline.CSOM -Source 'CayoNuGetV3' -ProviderName 'NuGet' -RequiredVersion %PackageVersion% -Scope AllUsers
```
  Cayosoft Administrator implements specific modules depending on the build version—replace the placeholder with the correct module version as per the following article: Required modules for Administrator Service.
- If the line returned a different version, remove the currently installed version and install the required one. Run the following lines:
  Copy
```
Uninstall-Package Microsoft.SharePointOnline.CSOM -AllVersions -Force -Confirm:$false
Install-Package Microsoft.SharePointOnline.CSOM -Source 'CayoNuGetV3' -ProviderName 'NuGet' -RequiredVersion %PackageVersion% -Scope AllUsers
```
  Replace the placeholder with the target module version as per the following article: Required modules for Administrator Service.
Start the Cayosoft Administrator Service. Run the following line in the console:
Copy
```
Start-Service CayoAdminService
```

SharePoint Online Management Shell module

Expand the element to learn more about the steps to manually install the module. Collapse the element to hide the steps.

Refer to the following steps to install the component:

Run an elevated instance of PowerShell ISE—right-click the shortcut and select Run as administrator.
If you have already installed Cayosoft Administrator, stop the Cayosoft Administrator Service. Run the following line in the console:
Copy
```
Stop-Service CayoAdminService
```
Run the following line to check your current Exchange Online module version:
Copy
```
Get-Module Microsoft.Online.SharePoint.PowerShell -ListAvailable
```
Perform further steps based on the output of the line.
- If the line did not return any output, install the module. Run the following line:
  Copy
```
Install-Module Microsoft.Online.SharePoint.PowerShell -Confirm:$False -Scope AllUsers -RequiredVersion %ModuleVersion%
```
  Cayosoft Administrator implements specific modules depending on the build version—replace the placeholder with the correct module version as per the following article: Required modules for Administrator Service.
- If the line returned a different version, remove the currently installed version and install the required one. Run the following lines:
  Copy
```
Uninstall-Module Microsoft.Online.SharePoint.PowerShell -Confirm:$False -AllVersions
Install-Module Microsoft.Online.SharePoint.PowerShell -Confirm:$False -Scope AllUsers -RequiredVersion %ModuleVersion%
```
  Replace the placeholder with the target module version as per the following article: Required modules for Administrator Service.
Start the Cayosoft Administrator Service. Run the following line in the console:
Copy
```
Start-Service CayoAdminService
```

Change history

Version	History
12.2.2	The article has been revised to list steps for manual module installation and remove information about the deprecated MSOnline module.

Articles in this section

Overview

List of dependencies

Installing components

Installing components using Requirements Check tool

Installing components manually

Windows Management Framework v5.1

PowerShell Gallery module

Active Directory module for Windows PowerShell (RSAT)

Exchange Online PowerShell module

Teams PowerShell module

SharePoint Client-Side Object Model module

SharePoint Online Management Shell module

Change history

Comments

Articles in this section

Overview

List of dependencies

Installing components

Installing components using Requirements Check tool

Installing components manually

Windows Management Framework v5.1

PowerShell Gallery module

Active Directory module for Windows PowerShell (RSAT)

Exchange Online PowerShell module

Teams PowerShell module

SharePoint Client-Side Object Model module

SharePoint Online Management Shell module

Change history

Related articles