Installation
Prerequisites:
- PowerShell 7+ (required for new installs). Windows PowerShell 5.1 is still supported for users running older module releases — see the Troubleshooting page for the TLS 1.2 setup required on 5.1.
- Thycotic Secret Server Web Service enabled
- A user to authenticate with appropriate permissions to access desired objects.
Thycotic.SecretServer is available to download from the following locations:
- GitHub Release (current: v0.62.0)
- CDN Download
- Direct Download
- PowerShell Gallery — not updated past 0.60.4 (tracking: #450)
Choose one of the following methods to obtain & install the module:
Option 1: Manual Install
You can manually copy the module to a desired PowerShell Modules path, PSModulePath.
The paths included in PSModulePath can be found using the following command:
$env:PSModulePath.split(';')
Place the Thycotic.SecretServer module folder in one of the listed locations.
More: about_PSModulePath
There are multiple options for downloading the module files:
GitHub Release
- Download the latest release from GitHub
- Unblock & Extract the
Thycotic.SecretServer.zip - Copy the
Thycotic.SecretServerfolder to your “Powershell Modules” directory of choice.
CDN Download
- Download the latest release file
- Unblock & Extract the archive
- Copy the
Thycotic.SecretServerfolder to your “Powershell Modules” directory of choice.
Direct Download
- Download the latest release file
- Unblock & Extract the archive
- Copy the
Thycotic.SecretServerfolder to your “Powershell Modules” directory of choice.
Integrity verification
Each GitHub Release includes a Thycotic.SecretServer_hash.txt asset with the SHA256 of that release’s zip. For v0.62.0:
- https://github.com/thycotic-ps/thycotic.secretserver/releases/download/v0.62.0/Thycotic.SecretServer_hash.txt
For other releases, browse to the Releases page and grab the hash asset attached to that release. Verify your downloaded zip:
Get-FileHash -Algorithm SHA256 .\Thycotic.SecretServer.zip
Compare the output to the contents of the hash file.
Verification
Validate Install:
Get-Module -ListAvailable Thycotic.SecretServer
# or
Get-InstalledModule Thycotic.SecretServer
Confirm the installed version matches the release you downloaded:
(Get-Module -ListAvailable Thycotic.SecretServer).Version
Import the module:
Import-Module Thycotic.SecretServer
List Module Commands:
Get-Command -Module Thycotic.SecretServer
Get detailed information on specific commands:
Get-Help Get-TssSecret -Full
Option 2: Install from PowerShell Gallery
Warning PowerShell Gallery is not updated past 0.60.4. Installing from PSGallery will give you an outdated module missing the fixes and features in 0.61.x and 0.62.0. Use Option 1 (Manual Install) to get the current release. Tracking: #450.
-
Open a PowerShell prompt
-
Execute the following command:
Install-Module -Name Thycotic.SecretServer -Scope CurrentUser
Warning PowerShell 7+ must be used to download the module from the PowerShell Gallery.
Warning Windows PowerShell 5.1 TLS error: PowerShell Gallery only supports TLS 1.2 and above, errors noted here may be observed. You will need to start a new PowerShell session and set TLS to 1.2:
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12. PowerShell 7 negotiates TLS automatically and does not need this step. See Troubleshooting for more.