Installing the 1E PowerShell Toolkit

Downloading the 1E PowerShell Toolkit

You can download the 1E PowerShell Toolkit from the Releases page of the 1E Support Portal. For information on how to log in to the Support Portal, refer to 1E Support.

Installing the 1E PowerShell Toolkit

You only need to unzip the Toolkit files to the folder of your choice. You can then simply activate a PowerShell session using the Toolkit:

Copy 
import-module .\ps1EToolkit -Force

This ensures that the version of the Toolkit you are using will always override any existing copy of it that may have been copied to the default module folder location.

You can use the get-1EToolkitversion to determine the currently active version of the Toolkit at any time.

Installing to the default module folder location

If you want to use the toolkit without having to remember the path you copied it to, you can choose to install it in the default folder location. You can then simply use the import-module cmdlet without specifying the toolkit path.

To install the 1E PowerShell Toolkit to the default module folder, copy the Toolkit files to the appropriate default PowerShell module folder location. This will make them available to either the current user or all users on the install device, depending on the path you choose.

To see the appropriate folder locations, examine the $Env:PSModulePath variable in PowerShell. The first location is the per-user module folder, and the second location is the per-machine install folder. This is typically the following:

C:\Program Files\WindowsPowerShell\Modules\

Assuming you are installing to the per-machine folder, create a new folder under this path called PS1EToolkit. Then copy the following files into this folder:

  • PS1EToolkit.psd1

  • PS1Etoolkit.psm1

You can now import the Toolkit into a PowerShell session by typing the following:

Copy 
import-module PS1EToolkit

As of release 1.2.0 of the Toolkit, the prefixes for cmdlets have been changed to 1E from Tachyon to reflect the company rebranding and renaming of its products.

If you are overwriting an older version of the Toolkit, then you may wish to remove the two files associated with the older version of the Toolkit, although they can coexist (PSTachyonToolkit.psd1 and PSTachyonToolkit.psm1).

If you have scripts that use the Tachyon prefix, and you prefer not to change them to use the 1E prefix, then refer to  Compatibility with legacy scripts.

You can use the optional -Force parameter to import-module to ensure that the module is always imported, even if already present. This may be useful if you have an older version of the Toolkit already installed to the default module folder location but want to override it with a later version, which is in a specific folder.

You can use the get-1EToolkitversion to determine the currently active version of the Toolkit at any time.

Setting the 1E Platform server

Refer to Setting the 1E Platform server in Requirements for using the 1E PowerShell Toolkit.

Script customization

Refer to Script customization in Requirements for using the 1E PowerShell Toolkit.

Toolkit files

The 1E PowerShell Toolkit contains the following files:

  • PS1EToolkit.psm1: The code for the toolkit.

  • PS1EToolkit.psd1: The manifest for the toolkit.