Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,4 @@ plugins:
- jemoji
- jekyll-avatar
- jekyll-mentions
- jekyll-redirect-from
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Add-TssEventPipeline
parent: Event Pipeline Policies
grand_parent: Commands
redirect_from:
- /commands/event-pipeline-policy/Add-TssEventPipeline
---
# Add-TssEventPipeline

Expand Down Expand Up @@ -118,6 +120,6 @@ Requires TssSession object returned by New-TssSession

## RELATED LINKS

[https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline-policy/Add-TssEventPipeline](https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline-policy/Add-TssEventPipeline)
[https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline-policies/Add-TssEventPipeline](https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline-policies/Add-TssEventPipeline)

[https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/event-pipeline-policy/Add-TssEventPipeline.ps1](https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/event-pipeline-policy/Add-TssEventPipeline.ps1)
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Disable-TssEventPipelinePolicy
parent: Event Pipeline Policies
grand_parent: Commands
redirect_from:
- /commands/event-pipeline-policy/Disable-TssEventPipelinePolicy
---
# Disable-TssEventPipelinePolicy

Expand Down Expand Up @@ -102,6 +104,6 @@ Requires TssSession object returned by New-TssSession

## RELATED LINKS

[https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline-policy/Disable-TssEventPipelinePolicy](https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline-policy/Disable-TssEventPipelinePolicy)
[https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline-policies/Disable-TssEventPipelinePolicy](https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline-policies/Disable-TssEventPipelinePolicy)

[https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/event-pipeline-policy/Disable-TssEventPipelinePolicy.ps1](https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/event-pipeline-policy/Disable-TssEventPipelinePolicy.ps1)
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Enable-TssEventPipelinePolicy
parent: Event Pipeline Policies
grand_parent: Commands
redirect_from:
- /commands/event-pipeline-policy/Enable-TssEventPipelinePolicy
---
# Enable-TssEventPipelinePolicy

Expand Down Expand Up @@ -102,6 +104,6 @@ Requires TssSession object returned by New-TssSession

## RELATED LINKS

[https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline-policy/Enable-TssEventPipelinePolicy](https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline-policy/Enable-TssEventPipelinePolicy)
[https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline-policies/Enable-TssEventPipelinePolicy](https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline-policies/Enable-TssEventPipelinePolicy)

[https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/event-pipeline-policy/Enable-TssEventPipelinePolicy.ps1](https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/event-pipeline-policy/Enable-TssEventPipelinePolicy.ps1)
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Get-TssEventPipelinePolicy
parent: Event Pipeline Policies
grand_parent: Commands
redirect_from:
- /commands/event-pipeline-policy/Get-TssEventPipelinePolicy
---
# Get-TssEventPipelinePolicy

Expand Down Expand Up @@ -72,6 +74,6 @@ Requires TssSession object returned by New-TssSession

## RELATED LINKS

[https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline-policy/Get-TssEventPipelinePolicy](https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline-policy/Get-TssEventPipelinePolicy)
[https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline-policies/Get-TssEventPipelinePolicy](https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline-policies/Get-TssEventPipelinePolicy)

[https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/event-pipeline-policy/Get-TssEventPipelinePolicy.ps1](https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/event-pipeline-policy/Get-TssEventPipelinePolicy.ps1)
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Get-TssEventPipelinePolicyActivity
parent: Event Pipeline Policies
grand_parent: Commands
redirect_from:
- /commands/event-pipeline-policy/Get-TssEventPipelinePolicyActivity
---
# Get-TssEventPipelinePolicyActivity

Expand Down Expand Up @@ -96,6 +98,6 @@ Requires TssSession object returned by New-TssSession

## RELATED LINKS

[https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline-policy/Get-TssEventPipelinePolicyActivity](https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline-policy/Get-TssEventPipelinePolicyActivity)
[https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline-policies/Get-TssEventPipelinePolicyActivity](https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline-policies/Get-TssEventPipelinePolicyActivity)

[https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/event-pipeline-policy/Get-TssEventPipelinePolicyActivity.ps1](https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/event-pipeline-policy/Get-TssEventPipelinePolicyActivity.ps1)
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Remove-TssEventPipeline
parent: Event Pipeline Policies
grand_parent: Commands
redirect_from:
- /commands/event-pipeline-policy/Remove-TssEventPipeline
---
# Remove-TssEventPipeline

Expand Down Expand Up @@ -118,6 +120,6 @@ Requires TssSession object returned by New-TssSession

## RELATED LINKS

[https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline-policy/Remove-TssEventPipeline](https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline-policy/Remove-TssEventPipeline)
[https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline-policies/Remove-TssEventPipeline](https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline-policies/Remove-TssEventPipeline)

[https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/event-pipeline-policy/Remove-TssEventPipeline.ps1](https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/event-pipeline-policy/Remove-TssEventPipeline.ps1)
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Search-TssEventPipelinePolicy
parent: Event Pipeline Policies
grand_parent: Commands
redirect_from:
- /commands/event-pipeline-policy/Search-TssEventPipelinePolicy
---
# Search-TssEventPipelinePolicy

Expand Down Expand Up @@ -156,6 +158,6 @@ Requires TssSession object returned by New-TssSession

## RELATED LINKS

[https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline-policy/Search-TssEventPipelinePolicy](https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline-policy/Search-TssEventPipelinePolicy)
[https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline-policies/Search-TssEventPipelinePolicy](https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline-policies/Search-TssEventPipelinePolicy)

[https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/event-pipeline-policy/Search-TssEventPipelinePolicy.ps1](https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/event-pipeline-policy/Search-TssEventPipelinePolicy.ps1)
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Event Pipeline Policies
parent: Commands
has_children: true
nav_order: 21
redirect_from:
- /commands/event-pipeline-policy/
---

# Event Pipeline Policies
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: Disable-TssEventPipeline
parent: Event Pipeline
parent: Event Pipelines
grand_parent: Commands
redirect_from:
- /commands/event-pipeline/Disable-TssEventPipeline
---
# Disable-TssEventPipeline

Expand Down Expand Up @@ -102,6 +104,6 @@ Requires TssSession object returned by New-TssSession

## RELATED LINKS

[https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline/Disable-TssEventPipeline](https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline/Disable-TssEventPipeline)
[https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipelines/Disable-TssEventPipeline](https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipelines/Disable-TssEventPipeline)

[https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/event-pipeline/Disable-TssEventPipeline.ps1](https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/event-pipeline/Disable-TssEventPipeline.ps1)
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: Enable-TssEventPipeline
parent: Event Pipeline
parent: Event Pipelines
grand_parent: Commands
redirect_from:
- /commands/event-pipeline/Enable-TssEventPipeline
---
# Enable-TssEventPipeline

Expand Down Expand Up @@ -102,6 +104,6 @@ Requires TssSession object returned by New-TssSession

## RELATED LINKS

[https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline/Enable-TssEventPipeline](https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline/Enable-TssEventPipeline)
[https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipelines/Enable-TssEventPipeline](https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipelines/Enable-TssEventPipeline)

[https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/event-pipeline/Enable-TssEventPipeline.ps1](https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/event-pipeline/Enable-TssEventPipeline.ps1)
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: Get-TssEventPipeline
parent: Event Pipeline
parent: Event Pipelines
grand_parent: Commands
redirect_from:
- /commands/event-pipeline/Get-TssEventPipeline
---
# Get-TssEventPipeline

Expand Down Expand Up @@ -72,6 +74,6 @@ Requires TssSession object returned by New-TssSession

## RELATED LINKS

[https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline/Get-TssEventPipeline](https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline/Get-TssEventPipeline)
[https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipelines/Get-TssEventPipeline](https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipelines/Get-TssEventPipeline)

[https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/event-pipeline/Get-TssEventPipeline.ps1](https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/event-pipeline/Get-TssEventPipeline.ps1)
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: Get-TssEventPipelineRun
parent: Event Pipeline
parent: Event Pipelines
grand_parent: Commands
redirect_from:
- /commands/event-pipeline/Get-TssEventPipelineRun
---
# Get-TssEventPipelineRun

Expand Down Expand Up @@ -72,6 +74,6 @@ Requires TssSession object returned by New-TssSession

## RELATED LINKS

[https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline/Get-TssEventPipelineRun](https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline/Get-TssEventPipelineRun)
[https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipelines/Get-TssEventPipelineRun](https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipelines/Get-TssEventPipelineRun)

[https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/event-pipeline/Get-TssEventPipelineRun.ps1](https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/event-pipeline/Get-TssEventPipelineRun.ps1)
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: Search-TssEventPipeline
parent: Event Pipeline
parent: Event Pipelines
grand_parent: Commands
redirect_from:
- /commands/event-pipeline/Search-TssEventPipeline
---
# Search-TssEventPipeline

Expand Down Expand Up @@ -158,6 +160,6 @@ Requires TssSession object returned by New-TssSession

## RELATED LINKS

[https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline/Search-TssEventPipeline](https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipeline/Search-TssEventPipeline)
[https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipelines/Search-TssEventPipeline](https://thycotic-ps.github.io/thycotic.secretserver/commands/event-pipelines/Search-TssEventPipeline)

[https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/event-pipeline/Search-TssEventPipeline.ps1](https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/event-pipeline/Search-TssEventPipeline.ps1)
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
---
title: Event Pipeline
title: Event Pipelines
parent: Commands
has_children: true
nav_order: 20
redirect_from:
- /commands/event-pipeline/
---

# Event Pipeline
# Event Pipelines

{% include list.liquid all=true %}
17 changes: 14 additions & 3 deletions docs/getting_started/compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,22 @@ nav_order: 3

# Compatibility

Secret Server REST API was first released with version 9.0. The API has grown since then and continues to grow as the product evolves. The module is tested on the latest Secret Server release available. This page aims to provide a list of endpoints that are only available in specific build versions of Secret Server.
Secret Server REST API was first released with version 9.0. The API has grown since then and continues to grow as the product evolves. This page lists endpoints that are only available in specific build versions of Secret Server.

> The starting version for maintaining this content will be Secret Server 10.9.
> The starting version for maintaining this content is Secret Server 10.9.

> Each function included below will have a version check on Secret Server before the endpoint is called.
> Each function included below has a version check on Secret Server before the endpoint is called.

## Response handling improvements in 0.62.0

Secret Server has added and renamed REST response properties across many releases. When the module's typed C# classes don't yet model a newly-added property, cmdlets that cast the response into one of those types fail with `Cannot convert value ... to type Thycotic.PowerShell.<...>`. The errors are not specific to any one Secret Server release — they show up whenever the deployed Secret Server returns fields the module's class definitions don't recognize.

Module v0.62.0 addresses this in two ways:

- A general `FilterTssResponse` pass is now applied by all functions before the type cast. Unknown properties are stripped (and reported via `Write-Verbose`) instead of breaking the cast.
- Three cmdlets received targeted fixes for nested-object cast failures that the general pass alone couldn't handle: `Get-TssConfiguration`, `Get-TssRpcPasswordType`, and `Get-TssDirectoryServiceSyncStatus`.

If you've been seeing `Cannot convert value` errors on older module releases, upgrading to v0.62.0 should resolve them regardless of which Secret Server version you're running. See [CHANGELOG](https://github.com/thycotic-ps/thycotic.secretserver/blob/dev/CHANGELOG.md) for the full list of fixes.

## Function List

Expand Down
8 changes: 6 additions & 2 deletions docs/getting_started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,13 +62,17 @@ There are multiple options for downloading the module files:

### Integrity verification

The published SHA256 hash for each release is at [thycotic.secretserver_hash.txt](https://thyproservices.z20.web.core.windows.net/Thycotic.SecretServer_hash.txt). Verify the downloaded zip before extracting:
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](https://github.com/thycotic-ps/thycotic.secretserver/releases) and grab the hash asset attached to that release. Verify your downloaded zip:

```powershell
Get-FileHash -Algorithm SHA256 .\Thycotic.SecretServer.zip
```

Compare the output to the hash file above.
Compare the output to the contents of the hash file.

## Verification

Expand Down
Loading