Docs - correcting links for CBH

thycotic-ps · Apr 28, 2021 · 8347663 · 8347663
1 parent 7fdd18b
commit 8347663
Show file tree

Hide file tree

Showing 9 changed files with 427 additions and 14 deletions.
diff --git a/docs/collections/_commands/Add-TssSecretTemplateField.md b/docs/collections/_commands/Add-TssSecretTemplateField.md
@@ -0,0 +1,132 @@
+---
+category: secrets
+external help file: Thycotic.SecretServer-help.xml
+Module Name: Thycotic.SecretServer
+online version: https://thycotic-ps.github.io/thycotic.secretserver/commands/Add-TssSecretTemplateField
+schema: 2.0.0
+title: Add-TssSecretTemplateField
+---
+
+# Add-TssSecretTemplateField
+
+## SYNOPSIS
+Add a new field to a Secret Template
+
+## SYNTAX
+
+```
+Add-TssSecretTemplateField [-TssSession] <TssSession> [-Id] <Int32[]> [-Field] <TssSecretTemplateField>
+ [-WhatIf] [-Confirm] [<CommonParameters>]
+```
+
+## DESCRIPTION
+Add a new field to a Secret Template
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+$session = New-TssSession 'https://alpha/SecretServer' $ssCred
+(Get-TssSecretTemplate -TssSession $session -Id 6042).Fields
+$newField = New-TssSecretTemplateField -FieldName 'Additional Field' -Searchable
+Add-TssSecretTemplateField -TssSession $session -Id 6042 -Field $newField
+(Get-TssSecretTemplate -TssSession $session -Id 6042).Fields
+```
+
+Output the current fields for Secret Template 6042, create a new field named "Additional Field" that is searchable and add to the Secret Template 6042
+
+## PARAMETERS
+
+### -TssSession
+TssSession object created by New-TssSession for auth
+
+```yaml
+Type: TssSession
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: True (ByValue)
+Accept wildcard characters: False
+```
+
+### -Id
+Template Stub object
+
+```yaml
+Type: Int32[]
+Parameter Sets: (All)
+Aliases: TemplateId
+
+Required: True
+Position: 2
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Field
+Fields, use New-TssSecretTemplateField to build this object
+
+```yaml
+Type: TssSecretTemplateField
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 3
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -WhatIf
+Shows what would happen if the cmdlet runs.
+The cmdlet is not run.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: wi
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Confirm
+Prompts you for confirmation before running the cmdlet.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: cf
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### CommonParameters
+This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
+
+## INPUTS
+
+## OUTPUTS
+
+### TssSecretTemplate
+## NOTES
+Requires TssSession object returned by New-TssSession
+
+## RELATED LINKS
+
+[https://thycotic-ps.github.io/thycotic.secretserver/commands/Add-TssSecretTemplateField](https://thycotic-ps.github.io/thycotic.secretserver/commands/Add-TssSecretTemplateField)
+
+[https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/secret-templates/Add-SecretTemplateField](https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/secret-templates/Add-SecretTemplateField)
+
diff --git a/docs/collections/_commands/Get-TssGroupMember.md b/docs/collections/_commands/Get-TssGroupMember.md
@@ -124,5 +124,5 @@ Requires TssSession object returned by New-TssSession
 
 [https://thycotic-ps.github.io/thycotic.secretserver/commands/Get-TssGroupMember](https://thycotic-ps.github.io/thycotic.secretserver/commands/Get-TssGroupMember)
 
-[https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/<folder>/Get-GroupMember.ps1](https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/<folder>/Get-GroupMember.ps1)
+[https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/groups/Get-GroupMember.ps1](https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/groups/Get-GroupMember.ps1)
 
diff --git a/docs/collections/_commands/New-TssSecretTemplate.md b/docs/collections/_commands/New-TssSecretTemplate.md
@@ -14,22 +14,44 @@ Create a new Secret Template
 
 ## SYNTAX
 
+### newcopy
 ```
-New-TssSecretTemplate [-TssSession] <TssSession> [-Template] <TssSecretTemplate> [-WhatIf] [-Confirm]
+New-TssSecretTemplate [-TssSession] <TssSession> -Template <TssSecretTemplate> [-WhatIf] [-Confirm]
  [<CommonParameters>]
 ```
 
+### new
+```
+New-TssSecretTemplate [-TssSession] <TssSession> -TemplateName <String>
+ -TemplateField <TssSecretTemplateField[]> [-WhatIf] [-Confirm] [<CommonParameters>]
+```
+
 ## DESCRIPTION
 Create a new Secret Template
 
 ## EXAMPLES
 
-### Example 1
-```powershell
-PS C:\> {{ Add example code here }}
+### EXAMPLE 1
+```
+$session = New-TssSession 'https://alpha/SecretServer' $ssCred
+$copyTemplate = Get-TssSecretTemplate -TssSession $session -Id 6042
+$copyTemplate.Name = 'Test Template - copy of 6042'
+New-TssSecretTemplate -TssSession $session -Template $copyTemplate
+```
+
+Gets the Secret Template 6042, changing the name of the Template and then creating it
+
+### EXAMPLE 2
+```
+$session = New-TssSession 'https://alpha/SecretServer' $ssCred
+$fields = @()
+$fields += New-TssSecretTemplateField -FieldName 'Field 1 Username' -Searchable
+$fields += New-TssSecretTemplateField -FieldName 'Field 2 Password' -Type Password
+$fields += New-TssSecretTemplateField -FieldName 'Field 3 URL' -Type Url -Searchable
+New-TssSecretTemplate -TssSession $session -TemplateName 'Test Template 42' -TemplateField $fields
 ```
 
-{{ Add example description here }}
+Creates a new template named "Test Template 42" with 3 fields
 
 ## PARAMETERS
 
@@ -53,16 +75,46 @@ Template Stub object
 
 ```yaml
 Type: TssSecretTemplate
-Parameter Sets: (All)
+Parameter Sets: newcopy
 Aliases: TemplateStub
 
 Required: True
-Position: 2
+Position: Named
 Default value: None
 Accept pipeline input: True (ByValue)
 Accept wildcard characters: False
 ```
 
+### -TemplateName
+Template Name
+
+```yaml
+Type: String
+Parameter Sets: new
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -TemplateField
+Fields, use New-TssSecretTemplateField to build this object
+
+```yaml
+Type: TssSecretTemplateField[]
+Parameter Sets: new
+Aliases: Fields
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -WhatIf
 Shows what would happen if the cmdlet runs.
 The cmdlet is not run.
@@ -109,5 +161,5 @@ Requires TssSession object returned by New-TssSession
 
 [https://thycotic-ps.github.io/thycotic.secretserver/commands/New-TssSecretTemplate](https://thycotic-ps.github.io/thycotic.secretserver/commands/New-TssSecretTemplate)
 
-[https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/<folder>/New-SecretTemplate.ps1](https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/<folder>/New-SecretTemplate.ps1)
+[https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/secret-templates/New-SecretTemplate.ps1](https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/secret-templates/New-SecretTemplate.ps1)