Install and maintain the PowerShell module

You download the module from the PowerShell gallery

The procedures in this section explain how to install, update, and uninstall the PSOdoo module.

Supported operating systems for the PowerShell module

PowerShell 7 and later is the required PowerShell version for use with the PSOdoo module on Windows, Linux, and Apple macOS. There are no additional prerequisites to use the SDK with PowerShell 7 or later.

For more information about PowerShell 7, see Announcing PowerShell 7.0.

Apple macOS

The module is supported in the following versions of macOS:

• macOS 11 Big Sur or later
• macOS 10.15 Catalina
• macOS 10.14 Mojave

For instructions on installing PowerShell 7 on macOS, see Installing PowerShell on macOS.

Now you can do the regular PowerShell prerequisites and install the PowerShell module.

Linux

The module is officially supported in the following distributions of Linux:

• Ubuntu 18.04 LTS
• Ubuntu 20.04 LTS
• Debian 11 (Bullseye)
• Debian 12 (Bookworm)

If you have trouble using the module in other distributions of Linux, report any issues.

For instructions on installing PowerShell 7 on Linux, see Installing PowerShell on Linux.

Now you can do the regular PowerShell prerequisites and install the PowerShell module.

Windows

The module is supported in the following versions of Windows:

• Windows Server 2019
• Windows Server 2022
• Windows 10
• Windows 11

If you have trouble using the module in other versions of Windows, report any issues.

For instructions on installing PowerShell 7 on Windows, see Installing PowerShell on Windows.

Now you can do the regular PowerShell prerequisites and install the PowerShell module.

Prerequisites for the PowerShell module

Set the PowerShell execution policy to RemoteSigned

note

The settings in this section apply to all versions of PowerShell on all operating systems.

PowerShell needs to be configured to run scripts, and by default, it isn't. You'll get the following error when you try to connect:

Files cannot be loaded because running scripts is disabled on this system. Provide a valid certificate with which to sign the files.

To require all PowerShell scripts that you download from the internet are signed by a trusted publisher, run the following command in an elevated PowerShell window (a PowerShell window you open by selecting Run as administrator):

PowerShell

Set-ExecutionPolicy RemoteSigned

For more information about execution policies, see About Execution Policies.

Install the PowerShell module

To install the module for the first time, complete the following steps:

1. Install or update the PowerShellGet module as described in Installing PowerShellGet.
2. Close and re-open the Windows PowerShell window.
3. Now you can use the Install-Module cmdlet to install the module from the PowerShell Gallery. Typically, you'll want the latest public version of the module, but you can also install a Preview version if any are available.

• To install the latest public version of the module, run one of the following commands:
  • In an elevated PowerShell window (all users): Install-Module -Name PSOdoo
    PowerShell

    Install-Module -Name PSOdoo
  • Only for the current user account:
    PowerShell

    Install-Module -Name PSOdoo -Scope CurrentUser
• To see the available Preview versions of the module, run the following command:
  PowerShell

  Find-Module PSOdoo -AllVersions -AllowPrerelease
• To install the latest available Preview version of the module, run one of the following commands:
  • In an elevated PowerShell window (all users):
    PowerShell

    Install-Module -Name PSOdoo -AllowPrerelease
  • Only for the current user account:
    PowerShell

    Install-Module -Name PSOdoo -Scope CurrentUser -AllowPrerelease
• To install a specific Preview version of the module, replace <PreviewVersion> with the necessary value, and run one of the following commands:
  • In an elevated PowerShell window (all users):
    PowerShell

    Install-Module -Name PSOdoo -RequiredVersion <PreviewVersion> -AllowPrerelease
  • Only for the current user account:
    PowerShell

    Install-Module -Name PSOdoo -RequiredVersion <PreviewVersion> -AllowPrerelease -Scope CurrentUser

When you're finished, enter Y to accept the license agreement.

For detailed syntax and parameter information, see Install-Module.

Update the PSOdoo module

If the module is already installed on your computer, you can use the procedures in this section to update the module.

1. To see the version of the module that's currently installed and where it's installed, run the following command:

   PowerShell

   Get-InstalledModule PSOdoo | Format-List Name,Version,InstalledLocation

   If the module is installed in C:\Program Files\WindowsPowerShell\Modules, it's installed for all users. If the module is installed in your Documents folder, it's installed only for the current user account.

2. You can use the Update-Module cmdlet to update the module from the PowerShell Gallery. Typically, you'll want the latest public version of the module, but you can also upgrade to a Preview version if any are available.

   To upgrade to the latest public version of the module, run one of the following commands based on how you originally installed the module (all users vs. only for the current user account):

   • In an elevated PowerShell window (all users):
     PowerShell

     Update-Module -Name PSOdoo
   • Only for the current user account:
     PowerShell

     Update-Module -Name PSOdoo -Scope CurrentUser

   To upgrade to a Preview version of the module, you can upgrade to the latest available Preview version, or you can use the RequiredVersion parameter to upgrade to a specific Preview version.

   • To see the available Preview versions of the module, run the following command:
     PowerShell

     Find-Module PSOdoo -AllVersions -AllowPrerelease

   To upgrade to the latest available Preview version of the module, run one of the following commands:

   • In an elevated PowerShell window (all users):
     PowerShell

     Update-Module -Name PSOdoo -AllowPrerelease
   • Only for the current user account:
     PowerShell

     Update-Module -Name PSOdoo -Scope CurrentUser -AllowPrerelease

   To upgrade to a specific Preview version of the module, replace <PreviewVersion> with the necessary value, and run one of the following commands:

   • In an elevated PowerShell window (all users):
     PowerShell

     Update-Module -Name PSOdoo -RequiredVersion <PreviewVersion> -AllowPrerelease
   • Only for the current user account:
     PowerShell

     Update-Module -Name PSOdoo -Scope CurrentUser -RequiredVersion <PreviewVersion> -AllowPrerelease

   When you're finished, enter Y to accept the license agreement.

3. To confirm that the update was successful, run the following commands to check the version information of the module that's installed:

   PowerShell

   Import-Module PSOdoo; Get-Module PSOdoo

For detailed syntax and parameter information, see Update-Module.

Troubleshoot installing the PowerShell module

• You receive one of the following errors:

  The specified module 'PSOdoo' with PowerShellGetFormatVersion '<version>' isn't supported by the current version of PowerShellGet. Get the latest version of the PowerShellGet module to install this module, 'PSOdoo'.

  WARNING: Unable to download from URI 'https://go.microsoft.com/fwlink/?LinkID=627338&clcid=0x409' to ''.

  WARNING: Unable to download the list of available providers. Check your internet connection.

  Update your installation of the PowerShellGet module to the latest version as described in Installing PowerShellGet. Be sure to close and re-open the PowerShell window before you attempt to update the PSOdoo module again.

• As of April 2020, the PowerShell Gallery only supports connections using TLS 1.2 or later. For more information, see PowerShell Gallery TLS Support.

  To check your current settings in the Microsoft .NET Framework, run the following command in Windows PowerShell:

  PowerShell

  [Net.ServicePointManager]::SecurityProtocol

  As described in the PowerShell Gallery TLS Support article, to temporarily change the security protocol to TLS 1.2 to install the PowerShellGet or PSOdoo modules, run the following command in Windows PowerShell before you install the module:

  PowerShell

  [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12

  To permanently enable strong cryptography in the Microsoft .NET Framework version 4.x or later, run one of the following commands based on your Windows architecture:

  • x64:
  PowerShell

  Set-ItemProperty -Path 'HKLM:\SOFTWARE\Wow6432Node\Microsoft\.NETFramework\v4.0.30319' -Name 'SchUseStrongCrypto' -Type DWord -Value '1'
  • x86:
  PowerShell

  Set-ItemProperty -Path 'HKLM:\SOFTWARE\Microsoft\.NETFramework\v4.0.30319' -Name 'SchUseStrongCrypto' -Type DWord -Value '1'

  For more information, see SchUseStrongCrypto.

• You receive the following error: No match was found for the specified search criteria and module name 'PSOdoo'. Try running Get-PSRepository to see all available registered module repositories.

  The default repository for PowerShell modules isn't set to PSGallery. To fix this error, run the following command:

  PowerShell

  Register-PSRepository -Default

Uninstall the PowerShell module

To see the version of the module that's currently installed and where it's installed, run the following command:

PowerShell

Get-InstalledModule PSOdoo | Format-List Name,Version,InstalledLocation

If the module is installed in C:\Program Files\WindowsPowerShell\Modules, it was installed for all users. If the module is installed in your Documents folder, it was installed only for the current user account.

To uninstall the module, run the following command in one of the following environments based on how you originally installed the module (all users vs. only for the current user account):

• In an elevated PowerShell window (all users).
• In a normal PowerShell window (only for the current user account).
  PowerShell

  Uninstall-Module -Name PSOdoo