Update manifest and docs to 6.2.0

Venafi · Mar 7, 2024 · 87090d3 · 87090d3
1 parent c469ea1
commit 87090d3
Show file tree

Hide file tree

Showing 16 changed files with 890 additions and 190 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,13 @@
+## 6.2.0
+- Add support for managing TLSPC Connectors via `Get-VcConnector`, `New-VcConnector`, `Set-VcConnector`, and `Remove-VcConnector`.  The old Connector functions, Get, New, and Remove, which were for managing Webhooks, have been renamed to more appropriately reflect their usage.  They are now `Get-VcWebhook`, `New-VcWebhook`, and `Remove-VcWebhook`.
+- Add support for TLSPC EU region with `New-VenafiSession -VcRegion`.  The default is 'us' and accepts 'eu' as well.  This detail will be stored in the resulting session and vault if utilized.
+- Update `Invoke-VcCertificateAction -Renew` to retrieve all existing CSR details, [#260](https://github.com/Venafi/VenafiPS/issues/260), [#264](https://github.com/Venafi/VenafiPS/issues/264).  Also update this function to return any missing/incorrect details when renewing.
+- Add `Invoke-VcCertificateAction -Renew -Force` to override the default behavior of stopping when more than 1 common name is encountered.  Use of `-Force` will use the first common name found in the array.
+- Update readme to remove deprecated -VaultMetadata parameter, [#256](https://github.com/Venafi/VenafiPS/issues/256)
+- Fix duplicate parameter error with `Get-VdcAttribute -All`, [#259](https://github.com/Venafi/VenafiPS/issues/259)
+- Update default value of `New-VcCertificate -ValidUntil` from 1 year to 90 days
+
+
 ## 6.1.4
 - Fix property not found error with `New-VenafiSession -AccessToken`, [#252](https://github.com/Venafi/VenafiPS/issues/252)
 - Update `Invoke-VenafiRestMethod` to ensure parameter verbose output does not convert the body to json twice
@@ -662,5 +672,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: Venafi
 #
-# Generated on: 02/01/2024
+# Generated on: 03/07/2024
 #
 
 @{
@@ -12,7 +12,7 @@
 RootModule = 'VenafiPS.psm1'
 
 # Version number of this module.
-ModuleVersion = '6.2'
+ModuleVersion = '6.2.0'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,3 +1,13 @@
+## 6.2.0
+- Add support for managing TLSPC Connectors via `Get-VcConnector`, `New-VcConnector`, `Set-VcConnector`, and `Remove-VcConnector`.  The old Connector functions, Get, New, and Remove, which were for managing Webhooks, have been renamed to more appropriately reflect their usage.  They are now `Get-VcWebhook`, `New-VcWebhook`, and `Remove-VcWebhook`.
+- Add support for TLSPC EU region with `New-VenafiSession -VcRegion`.  The default is 'us' and accepts 'eu' as well.  This detail will be stored in the resulting session and vault if utilized.
+- Update `Invoke-VcCertificateAction -Renew` to retrieve all existing CSR details, [#260](https://github.com/Venafi/VenafiPS/issues/260), [#264](https://github.com/Venafi/VenafiPS/issues/264).  Also update this function to return any missing/incorrect details when renewing.
+- Add `Invoke-VcCertificateAction -Renew -Force` to override the default behavior of stopping when more than 1 common name is encountered.  Use of `-Force` will use the first common name found in the array.
+- Update readme to remove deprecated -VaultMetadata parameter, [#256](https://github.com/Venafi/VenafiPS/issues/256)
+- Fix duplicate parameter error with `Get-VdcAttribute -All`, [#259](https://github.com/Venafi/VenafiPS/issues/259)
+- Update default value of `New-VcCertificate -ValidUntil` from 1 year to 90 days
+
+
 ## 6.1.4
 - Fix property not found error with `New-VenafiSession -AccessToken`, [#252](https://github.com/Venafi/VenafiPS/issues/252)
 - Update `Invoke-VenafiRestMethod` to ensure parameter verbose output does not convert the body to json twice
@@ -662,5 +672,6 @@ This is a major release.  Although every attempt has been made to be backwards c
 
 
 
+
 
 
diff --git a/docs/functions/Get-VcConnector.md b/docs/functions/Get-VcConnector.md
@@ -1,7 +1,7 @@
 # Get-VcConnector
 
 ## SYNOPSIS
-Get connector/webhook info
+Get connector info
 
 ## SYNTAX
 
@@ -17,7 +17,7 @@ Get-VcConnector [-All] [-VenafiSession <PSObject>] [-ProgressAction <ActionPrefe
 ```
 
 ## DESCRIPTION
-Get 1 or all connector/webhook info
+Get details on 1 or all connectors
 
 ## EXAMPLES
 

diff --git a/docs/functions/Get-VcWebhook.md b/docs/functions/Get-VcWebhook.md
@@ -0,0 +1,139 @@
+# Get-VcWebhook
+
+## SYNOPSIS
+Get webhook info
+
+## SYNTAX
+
+### ID (Default)
+```
+Get-VcWebhook [-ID] <String> [-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>]
+ [<CommonParameters>]
+```
+
+### All
+```
+Get-VcWebhook [-All] [-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
+```
+
+## DESCRIPTION
+Get 1 or all webhooks
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+Get-VcWebhook -ID 'ca7ff555-88d2-4bfc-9efa-2630ac44c1f2' | ConvertTo-Json
+```
+
+{
+    "webhookId": "a7ddd210-0a39-11ee-8763-134b935c90aa",
+    "name": "ServiceNow-expiry,
+    "properties": {
+        "connectorKind": "WEBHOOK",
+        "filter": {
+            "filterType": "EXPIRATION",
+            "applicationIds": \[\]
+        },
+        "target": {
+            "type": "generic",
+            "connection": {
+                "secret": "MySecret",
+                "url": "https://instance.service-now.com/api/company/endpoint"
+            }
+        }
+    }
+}
+
+Get a single object by ID
+
+### EXAMPLE 2
+```
+Get-VcWebhook -ID 'My Webhook'
+```
+
+Get a single object by name. 
+The name is case sensitive.
+
+### EXAMPLE 3
+```
+Get-VcWebhook -All
+```
+
+Get all webhooks
+
+## PARAMETERS
+
+### -ID
+Webhook ID or name
+
+```yaml
+Type: String
+Parameter Sets: ID
+Aliases: webhookId
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### -All
+Get all webhooks
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: All
+Aliases:
+
+Required: True
+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:
+
+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
+
+### ID
+## OUTPUTS
+
+## NOTES
+
+## RELATED LINKS
diff --git a/docs/functions/Invoke-VcCertificateAction.md b/docs/functions/Invoke-VcCertificateAction.md
@@ -19,7 +19,7 @@ Invoke-VcCertificateAction -ID <String> [-Recover] [-AdditionalParameters <Hasht
 
 ### Renew
 ```
-Invoke-VcCertificateAction -ID <String> [-Renew] [-AdditionalParameters <Hashtable>]
+Invoke-VcCertificateAction -ID <String> [-Renew] [-Force] [-AdditionalParameters <Hashtable>]
  [-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
@@ -50,13 +50,38 @@ Perform an action against 1 certificate
 
 ### EXAMPLE 2
 ```
+Invoke-VcCertificateAction -ID '3699b03e-ff62-4772-960d-82e53c34bf60' -Renew -AdditionalParameters @{'Application'='10f71a12-daf3-4737-b589-6a9dd1cc5a97'}
+```
+
+Perform an action against 1 certificate with additional parameters.
+In this case we are renewing a certificate, but the certificate has multiple applications associated with it.
+Only one certificate and application combination can be renewed at a time so provide the specific application to be renewed.
+
+### EXAMPLE 3
+```
+Invoke-VcCertificateAction -ID '3699b03e-ff62-4772-960d-82e53c34bf60' -Renew -Force
+```
+
+Renewals can only support 1 CN assigned to a certificate. 
+To force this function to renew and automatically select the first CN, use -Force.
+
+### EXAMPLE 4
+```
+Invoke-VcCertificateAction -ID '3699b03e-ff62-4772-960d-82e53c34bf60' -Delete
+```
+
+Delete a certificate. 
+As only retired certificates can be deleted, it will be retired first.
+
+### EXAMPLE 5
+```
 Invoke-VcCertificateAction -ID '3699b03e-ff62-4772-960d-82e53c34bf60' -Delete -Confirm:$false
 ```
 
 Perform an action bypassing the confirmation prompt. 
 Only applicable to Delete.
 
-### EXAMPLE 3
+### EXAMPLE 6
 ```
 Find-VcObject -Type Certificate -Filter @('certificateStatus','eq','retired') | Invoke-VcCertificateAction -Delete
 ```
@@ -111,7 +136,8 @@ Accept wildcard characters: False
 ```
 
 ### -Renew
-Requests immediate renewal for an existing certificate
+Requests immediate renewal for an existing certificate.
+If more than 1 application is associated with the certificate, provide -AdditionalParameters @{'Application'='application id'} to specify the id.
 
 ```yaml
 Type: SwitchParameter
@@ -156,6 +182,22 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -Force
+Force the operation under certain circumstances.
+- During a renewal, force choosing the first CN in the case of multiple CNs as only 1 is supported.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: Renew
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -AdditionalParameters
 Additional items specific to the action being taken, if needed.
 See the api documentation for appropriate items, many are in the links in this help.
@@ -243,10 +285,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ### ID
 ## OUTPUTS
 
-### PSCustomObject with the following properties:
+### When using retire and recover, PSCustomObject with the following properties:
 ###     CertificateID - Certificate uuid
 ###     Success - A value of true indicates that the action was successful
 ## NOTES
+If performing a renewal and subjectCN has more than 1 value, only the first will be submitted with the renewal.
 
 ## RELATED LINKS
 

diff --git a/docs/functions/New-VcCertificate.md b/docs/functions/New-VcCertificate.md
@@ -269,7 +269,7 @@ Aliases:
 
 Required: False
 Position: Named
-Default value: (Get-Date).AddYears(1)
+Default value: (Get-Date).AddDays(90)
 Accept pipeline input: False
 Accept wildcard characters: False
 ```