Update manifest and docs to 6.5.2

Venafi · Nov 1, 2024 · 879d00c · 879d00c
1 parent 732c9e6
commit 879d00c
Show file tree

Hide file tree

Showing 6 changed files with 215 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 6.5.2
+- Add `Set-VcCertificate`.  This replaces `Add-VcCertificateAssociation` to set the applications associated with a certificate.  Certificate tagging is now supported, both add and replace.
+- Add support for URL port during TLSPDC token operations, [#305](https://github.com/Venafi/VenafiPS/issues/305)
+
 ## 6.5.1
 - Fix Find-VdcObject documentation page not building, [#302](https://github.com/Venafi/VenafiPS/issues/302)
 - Rebranding post CyberArk acquisition
@@ -734,5 +738,6 @@ This is a major release.  Although every attempt has been made to be backwards c
 
 
 
+
 
 
diff --git a/VenafiPS/VenafiPS.psd1 b/VenafiPS/VenafiPS.psd1
@@ -3,7 +3,7 @@
 #
 # Generated by: Greg Brownstein
 #
-# Generated on: 10/09/2024
+# Generated on: 11/01/2024
 #
 
 @{
@@ -12,7 +12,7 @@
 RootModule = 'VenafiPS.psm1'
 
 # Version number of this module.
-ModuleVersion = '6.5.1'
+ModuleVersion = '6.5.2'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,3 +1,7 @@
+## 6.5.2
+- Add `Set-VcCertificate`.  This replaces `Add-VcCertificateAssociation` to set the applications associated with a certificate.  Certificate tagging is now supported, both add and replace.
+- Add support for URL port during TLSPDC token operations, [#305](https://github.com/Venafi/VenafiPS/issues/305)
+
 ## 6.5.1
 - Fix Find-VdcObject documentation page not building, [#302](https://github.com/Venafi/VenafiPS/issues/302)
 - Rebranding post CyberArk acquisition
@@ -734,5 +738,6 @@ This is a major release.  Although every attempt has been made to be backwards c
 
 
 
+
 
 
diff --git a/docs/functions/Add-VcCertificateAssociation.md b/docs/functions/Add-VcCertificateAssociation.md
@@ -56,7 +56,7 @@ Type 3 or more characters for tab completion to work.
 ```yaml
 Type: String
 Parameter Sets: (All)
-Aliases: CertificateID
+Aliases: certificateID
 
 Required: True
 Position: 1

diff --git a/docs/functions/Set-VcCertificate.md b/docs/functions/Set-VcCertificate.md
@@ -0,0 +1,201 @@
+# Set-VcCertificate
+
+## SYNOPSIS
+Update a certificate
+
+## SYNTAX
+
+### Application (Default)
+```
+Set-VcCertificate -Certificate <String> -Application <String[]> [-NoOverwrite] [-PassThru]
+ [-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
+```
+
+### Tag
+```
+Set-VcCertificate -Certificate <String> -Tag <String[]> [-NoOverwrite] [-PassThru] [-VenafiSession <PSObject>]
+ [-ProgressAction <ActionPreference>] [<CommonParameters>]
+```
+
+## DESCRIPTION
+Associate one or more certificates with one or more applications or tags.
+The associated applications/tags can either replace or be added to existing.
+By default, applications/tags will be replaced.
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+Add-VcCertificateAssociation -Certificate '7ac56ec0-2017-11ee-9417-a17dd25b82f9' -Application '96fc9310-67ec-11eb-a8a7-794fe75a8e6f'
+```
+
+Associate a certificate to an application
+
+### EXAMPLE 2
+```
+Add-VcCertificateAssociation -Certificate '7ac56ec0-2017-11ee-9417-a17dd25b82f9' -Application '96fc9310-67ec-11eb-a8a7-794fe75a8e6f', 'a05013bd-921d-440c-bc22-c9ead5c8d548'
+```
+
+Associate a certificate to multiple applications
+
+### EXAMPLE 3
+```
+Find-VcCertificate -First 5 | Add-VcCertificateAssociation -Application 'My Awesome App'
+```
+
+Associate multiple certificates to 1 application by name
+
+### EXAMPLE 4
+```
+Add-VcCertificateAssociation -Certificate '7ac56ec0-2017-11ee-9417-a17dd25b82f9' -Tag 'MyTagName'
+```
+
+Associate a certificate to a tag
+
+### EXAMPLE 5
+```
+Add-VcCertificateAssociation -Certificate '7ac56ec0-2017-11ee-9417-a17dd25b82f9' -Tag 'MyTagName:MyTagValue'
+```
+
+Associate a certificate to a tag name/value pair
+
+### EXAMPLE 6
+```
+Add-VcCertificateAssociation -Certificate '7ac56ec0-2017-11ee-9417-a17dd25b82f9' -Tag 'Tag1', 'MyTagName:MyTagValue'
+```
+
+Associate a certificate to multiple tags
+
+### EXAMPLE 7
+```
+Add-VcCertificateAssociation -Certificate 'www.barron.com' -Application '96fc9310-67ec-11eb-a8a7-794fe75a8e6f' -NoOverwrite
+```
+
+Associate a certificate, by name, to an additonal application, keeping the existing application in place
+
+## PARAMETERS
+
+### -Certificate
+Certificate ID or name to be associated.
+If a name is provided and multiple certificates are found, they will all be associated.
+Tab completion can be used for a list of certificate names to choose from.
+Type 3 or more characters for tab completion to work.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases: certificateID
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName, ByValue)
+Accept wildcard characters: False
+```
+
+### -Application
+One or more application IDs or names.
+Tab completion can be used for a list of application names.
+
+```yaml
+Type: String[]
+Parameter Sets: Application
+Aliases: applicationID
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Tag
+One of more tag names or name/value pairs.
+To specify a name/value pair, use the format 'name:value'.
+
+```yaml
+Type: String[]
+Parameter Sets: Tag
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -NoOverwrite
+Append to existing as opposed to overwriting
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -PassThru
+Return the newly updated certificate object(s)
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -VenafiSession
+Authentication for the function.
+The value defaults to the script session object $VenafiSession created by New-VenafiSession.
+A TLSPC key can also provided.
+
+```yaml
+Type: PSObject
+Parameter Sets: (All)
+Aliases: Key
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -ProgressAction
+{{ Fill ProgressAction Description }}
+
+```yaml
+Type: ActionPreference
+Parameter Sets: (All)
+Aliases: proga
+
+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
+
+### Certificate
+## OUTPUTS
+
+### PSCustomObject
+## NOTES
+
+## RELATED LINKS
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -128,6 +128,7 @@ nav:
     - Revoke-VdcToken: functions/Revoke-VdcToken.md
     - Search-VdcHistory: functions/Search-VdcHistory.md
     - Set-VcApplication: functions/Set-VcApplication.md
+    - Set-VcCertificate: functions/Set-VcCertificate.md
     - Set-VcConnector: functions/Set-VcConnector.md
     - Set-VcTeam: functions/Set-VcTeam.md
     - Set-VdcAttribute: functions/Set-VdcAttribute.md