Skip to content

Commit 463a400

Browse files
committed
module - doc updates
1 parent dc1fae1 commit 463a400

18 files changed

Lines changed: 59 additions & 5 deletions

src/functions/Get-Version.ps1

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@
1818
1919
Returns version of Secret Server alpha
2020
21+
.LINK
22+
https://thycotic.secretserver.github.io/commands/Get-TssVersion
23+
2124
.NOTES
2225
Requires TssSession object returned by New-TssSession
2326
#>

src/functions/Invoke-RestApi.ps1

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@
1010
Invoke-TssRestApi -Uri 'https://vault.company.com/api/v1/oauth2/token' -Method POST -Body $body
1111
1212
Performs POST request to the URI specified, returning the output from the endpoint.
13+
14+
.LINK
15+
https://thycotic.secretserver.github.io/commands/Invoke-TssRestApi
1316
#>
1417
[Cmdletbinding()]
1518
param(

src/functions/New-Session.ps1

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,33 +32,36 @@
3232
Create a credential object
3333
Use the alias nts to create a session object
3434
35+
.LINK
36+
https://thycotic.secretserver.github.io/commands/New-TssSession
37+
3538
.OUTPUTS
3639
TssSession.
3740
#>
3841
[cmdletbinding(SupportsShouldProcess)]
3942
[OutputType('TssSession')]
4043
param(
4144
# Secret Server URL
42-
[Parameter(ParameterSetName = 'New',Mandatory)]
43-
[Parameter(ParameterSetName = 'tss',
45+
[Parameter(ParameterSetName = 'new',Mandatory)]
46+
[Parameter(ParameterSetName = 'sdk',
4447
Mandatory)]
4548
[Alias('Server')]
4649
[uri]
4750
$SecretServer,
4851

4952
# Specify a Secret Server user account.
50-
[Parameter(ParameterSetName = 'New')]
53+
[Parameter(ParameterSetName = 'new')]
5154
[PSCredential]
5255
[Management.Automation.CredentialAttribute()]
5356
$Credential,
5457

5558
# Specify Access Token
5659
# Bypasses requesting a token from Secret Server
57-
[Parameter(ParameterSetName = 'tss')]
60+
[Parameter(ParameterSetName = 'sdk')]
5861
$AccessToken,
5962

6063
# Raw output from the endpoint will be returned.
61-
[Parameter(ParameterSetName = 'New')]
64+
[Parameter(ParameterSetName = 'new')]
6265
[switch]
6366
$Raw
6467
)

src/functions/Test-Version.ps1

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@
1212
1313
Pulls version of Secret Server and queries for latest version, returning object with details
1414
15+
.LINK
16+
https://thycotic.secretserver.github.io/commands/Test-TssVersion
17+
1518
.NOTES
1619
Requires TssSession object returned by New-TssSession
1720
#>

src/functions/folders/Get-Folder.ps1

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@
2424
2525
Returns folder associated with Folder ID, 93 and include Secret Templates associated with the folder
2626
27+
.LINK
28+
https://thycotic.secretserver.github.io/commands/Get-TssFolder
29+
2730
.NOTES
2831
Requires TssSession object returned by New-TssSession
2932
#>

src/functions/reports/Get-Report.ps1

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@
1212
1313
Gets the details on report ID 6
1414
15+
.LINK
16+
https://thycotic.secretserver.github.io/commands/Get-TssReport
17+
1518
.NOTES
1619
Requires TssSession object returned by New-TssSession
1720
#>

src/functions/reports/Get-ReportCategory.ps1

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@
1818
1919
Returns a list of all categories
2020
21+
.LINK
22+
https://thycotic.secretserver.github.io/commands/Get-TssReportCategory
23+
2124
.NOTES
2225
Requires TssSession object returned by New-TssSession
2326
#>

src/functions/reports/New-Report.ps1

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@
2424
2525
Create a new report where the T-SQL is stored in a SQL script file
2626
27+
.LINK
28+
https://thycotic.secretserver.github.io/commands/New-TssReport
29+
2730
.NOTES
2831
Requires TssSession object returned by New-TssSession
2932
#>

src/functions/reports/Remove-ReportCategory.ps1

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@
2020
Confirmation prompt is bypassed
2121
Removes report category 21
2222
23+
.LINK
24+
https://thycotic.secretserver.github.io/commands/Remove-TssReportCategory
25+
2326
.NOTES
2427
Requires TssSession object returned by New-TssSession
2528
#>

src/functions/reports/Search-ReportSchedule.ps1

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@
1818
1919
Returns list of all report schedules, including those that were deleted
2020
21+
.LINK
22+
https://thycotic.secretserver.github.io/commands/Search-TssReportSchedule
23+
2124
.NOTES
2225
Requires TssSession object returned by New-TssSession
2326
#>

0 commit comments

Comments
 (0)