Skip to content

Commit 0d98488

Browse files
committed
Update manifest and docs to 6.13.4
1 parent 1f153d8 commit 0d98488

File tree

7 files changed

+286
-23
lines changed

7 files changed

+286
-23
lines changed

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
## 6.13.4
2+
- Add `New-VdcCredential` to create a Password, Username Password, or Certificate Credential
3+
- Add `Invoke-VcCertificateAction -Application` and `-IssuingTemplate` for use during renewal operations to override existing values from certificate request. The template is optional if only 1 is associated to the application.
4+
- Enhance `Invoke-VcCertificateAction -Renew` to be smarter about determining the application and issuing template to use. For example, if the only template on an application was replaced, use the new one for renewal.
5+
- Fix `Invoke-VcCertificateAction -Renew -Wait` which was not waiting depending on certain statuses. Add automatic wait for renewal when provisioning afterwards.
6+
7+
18
## 6.13.3
29
- Add `New-VcCertificate -Wait` to wait for the certificate request to reach ternminal status, either success or failure. This is helpful when used with `-PassThru` to ensure a certificate is returned. [#383](https://github.com/Venafi/VenafiPS/issues/383).
310

@@ -949,5 +956,6 @@ This is a major release. Although every attempt has been made to be backwards c
949956

950957

951958

959+
952960

953961

VenafiPS/VenafiPS.psd1

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#
44
# Generated by: Greg Brownstein
55
#
6-
# Generated on: 03/12/2026
6+
# Generated on: 03/23/2026
77
#
88

99
@{
@@ -12,7 +12,7 @@
1212
RootModule = 'VenafiPS.psm1'
1313

1414
# Version number of this module.
15-
ModuleVersion = '6.13.3'
15+
ModuleVersion = '6.13.4'
1616

1717
# Supported PSEditions
1818
# CompatiblePSEditions = @()
@@ -113,7 +113,8 @@ FunctionsToExport = 'Add-VcTeamMember', 'Add-VcTeamOwner', 'Add-VdcAdaptableHash
113113
'Get-VcCloudProvider', 'Get-VcCloudKeystore', 'New-VcCloudKeystore',
114114
'Remove-VcCloudKeystore', 'New-VcCloudProvider',
115115
'Remove-VcCloudProvider', 'Set-VcUser', 'Export-VcReport',
116-
'Get-VcCertificateAuthority', 'Set-VcIssuingTemplate', 'New-VdcCredential'
116+
'Get-VcCertificateAuthority', 'Set-VcIssuingTemplate',
117+
'New-VdcCredential'
117118

118119
# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
119120
CmdletsToExport = @()

docs/changelog.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
## 6.13.4
2+
- Add `New-VdcCredential` to create a Password, Username Password, or Certificate Credential
3+
- Add `Invoke-VcCertificateAction -Application` and `-IssuingTemplate` for use during renewal operations to override existing values from certificate request. The template is optional if only 1 is associated to the application.
4+
- Enhance `Invoke-VcCertificateAction -Renew` to be smarter about determining the application and issuing template to use. For example, if the only template on an application was replaced, use the new one for renewal.
5+
- Fix `Invoke-VcCertificateAction -Renew -Wait` which was not waiting depending on certain statuses. Add automatic wait for renewal when provisioning afterwards.
6+
7+
18
## 6.13.3
29
- Add `New-VcCertificate -Wait` to wait for the certificate request to reach ternminal status, either success or failure. This is helpful when used with `-PassThru` to ensure a certificate is returned. [#383](https://github.com/Venafi/VenafiPS/issues/383).
310

@@ -949,5 +956,6 @@ This is a major release. Although every attempt has been made to be backwards c
949956

950957

951958

959+
952960

953961

docs/functions/Invoke-VcCertificateAction.md

Lines changed: 70 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ Invoke-VcCertificateAction -ID <Guid> [-Recover] [-BatchSize <Int32>] [-Addition
1919

2020
### Renew
2121
```
22-
Invoke-VcCertificateAction -ID <Guid> [-Renew] [-Provision] [-Wait] [-Force]
23-
[-AdditionalParameters <Hashtable>] [-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>] [-WhatIf]
24-
[-Confirm] [<CommonParameters>]
22+
Invoke-VcCertificateAction -ID <Guid> [-Renew] [-Provision] [-Application <String>] [-IssuingTemplate <String>]
23+
[-Wait] [-Force] [-AdditionalParameters <Hashtable>] [-VenafiSession <PSObject>]
24+
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
2525
```
2626

2727
### Validate
@@ -65,26 +65,24 @@ Perform an action against 1 certificate
6565

6666
### EXAMPLE 2
6767
```
68-
Invoke-VcCertificateAction -ID '3699b03e-ff62-4772-960d-82e53c34bf60' -Renew -AdditionalParameters @{'Application'='10f71a12-daf3-4737-b589-6a9dd1cc5a97'}
68+
Invoke-VcCertificateAction -ID '3699b03e-ff62-4772-960d-82e53c34bf60' -Renew -Application '10f71a12-daf3-4737-b589-6a9dd1cc5a97'
6969
```
7070

71-
Perform an action against 1 certificate with additional parameters.
72-
In this case we are renewing a certificate, but the certificate has multiple applications associated with it.
73-
Only one certificate and application combination can be renewed at a time so provide the specific application to be renewed.
71+
Perform an action against 1 certificate overriding the application used for renewal.
7472

7573
### EXAMPLE 3
7674
```
77-
Find-VcCertificate -Version CURRENT -Issuer i1 | Invoke-VcCertificateAction -Renew -AdditionalParameters @{'certificateIssuingTemplateId'='10f71a12-daf3-4737-b589-6a9dd1cc5a97'}
75+
Find-VcCertificate -Version CURRENT -Issuer i1 | Invoke-VcCertificateAction -Renew -IssuingTemplate 10f71a12-daf3-4737-b589-6a9dd1cc5a97
7876
```
7977

80-
Find all current certificates issued by i1 and renew them with a different issuer.
78+
Find all current certificates issued by i1 and renew them with a different template.
8179

8280
### EXAMPLE 4
8381
```
8482
Find-VcCertificate -Version CURRENT -Name 'mycert' | Invoke-VcCertificateAction -Renew -Wait
8583
```
8684

87-
Renew a certificate and wait for it to pass the Requested state (and hopefully Issued).
85+
Renew a certificate and wait for it to finish, either success or failure, before returning.
8886
This can be helpful if an Issuer takes a bit to enroll the certificate.
8987

9088
### EXAMPLE 5
@@ -174,8 +172,7 @@ Accept wildcard characters: False
174172
175173
### -Renew
176174
Requests immediate renewal for an existing certificate.
177-
If more than 1 application is associated with the certificate, provide -AdditionalParameters @{'Application'='application id'} to specify the id.
178-
Use -AdditionalParameters to provide additional parameters to the renewal request, see https://developer.venafi.com/tlsprotectcloud/reference/certificaterequests_create.
175+
Use \`-AdditionalParameters\` to provide additional parameters to the renewal request, see https://developer.venafi.com/tlsprotectcloud/reference/certificaterequests_create.
179176
180177
```yaml
181178
Type: SwitchParameter
@@ -253,7 +250,7 @@ Accept wildcard characters: False
253250
254251
### -Delete
255252
Delete a certificate.
256-
As only retired certificates can be deleted, this will be performed first.
253+
As only retired certificates can be deleted, this will be performed first, if needed.
257254
258255
```yaml
259256
Type: SwitchParameter
@@ -269,7 +266,8 @@ Accept wildcard characters: False
269266
270267
### -Provision
271268
By default, provision a certificate to all associated machine identities.
272-
When used with CloudKeystore, provision there instead.
269+
When used with -CloudKeystore, provision there instead.
270+
When used with -Renew, it will wait for the renewal to complete and then provision the renewed certificate, assuming the renewal was successful.
273271
274272
```yaml
275273
Type: SwitchParameter
@@ -310,6 +308,52 @@ Accept pipeline input: False
310308
Accept wildcard characters: False
311309
```
312310
311+
### -Application
312+
Optional name or ID of an application.
313+
Only needed in circumstances where the application can't be determined automatically.
314+
315+
If not provided, get the application from the original certificate request.
316+
If not available, check for associated applications with the certificate.
317+
If more than 1, throw an error as we don't know which to use, otherwise use that one application.
318+
319+
Renew only.
320+
321+
```yaml
322+
Type: String
323+
Parameter Sets: Renew
324+
Aliases:
325+
326+
Required: False
327+
Position: Named
328+
Default value: None
329+
Accept pipeline input: False
330+
Accept wildcard characters: False
331+
```
332+
333+
### -IssuingTemplate
334+
Optional name or ID of an issuing template.
335+
Only needed in circumstances where the issuing template can't be determined automatically.
336+
337+
If not provided, get the issuing template from the original certificate request.
338+
It might be this is available, but no longer valid for the application.
339+
In this case, check how many templates the application has.
340+
If only 1, use it, otherwise we can't continue.
341+
If not available from the original certificate request, perform the same 1 template check against the application to find a suitable template.
342+
343+
Renew only.
344+
345+
```yaml
346+
Type: String
347+
Parameter Sets: Renew
348+
Aliases:
349+
350+
Required: False
351+
Position: Named
352+
Default value: None
353+
Accept pipeline input: False
354+
Accept wildcard characters: False
355+
```
356+
313357
### -BatchSize
314358
How many certificates to retire per retirement API call.
315359
Useful to prevent API call timeouts.
@@ -330,7 +374,7 @@ Accept wildcard characters: False
330374
331375
### -Wait
332376
Wait for a long running operation to complete before returning
333-
- During a renewal, wait for the certificate to pass the Requested state
377+
- During a renewal, wait for enrollment to either succeed or fail
334378
335379
```yaml
336380
Type: SwitchParameter
@@ -346,7 +390,7 @@ Accept wildcard characters: False
346390
347391
### -Force
348392
Force the operation under certain circumstances.
349-
- During a renewal, force choosing the first CN in the case of multiple CNs as only 1 is supported.
393+
- During a renewal, force choosing the first CN in the case of multiple CNs as only 1 is supported via the API.
350394
351395
```yaml
352396
Type: SwitchParameter
@@ -388,7 +432,7 @@ Aliases:
388432

389433
Required: False
390434
Position: Named
391-
Default value: None
435+
Default value: (Get-VenafiSession)
392436
Accept pipeline input: False
393437
Accept wildcard characters: False
394438
```
@@ -451,12 +495,19 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
451495
### certificateID - Certificate uuid
452496
### success - A value of true indicates that the action was successful
453497
### error - error message if we failed
498+
### Renewals will also have oldCertificateId and renew properties
454499
## NOTES
455500
If performing a renewal and subjectCN has more than 1 value, only the first will be submitted with the renewal.
456501
457502
## RELATED LINKS
458503
459-
[https://api.venafi.cloud/webjars/swagger-ui/index.html?configUrl=%2Fv3%2Fapi-docs%2Fswagger-config&urls.primaryName=outagedetection-service](https://api.venafi.cloud/webjars/swagger-ui/index.html?configUrl=%2Fv3%2Fapi-docs%2Fswagger-config&urls.primaryName=outagedetection-service)
504+
[https://developer.venafi.com/tlsprotectcloud/reference/certificateretirement_recovercertificates](https://developer.venafi.com/tlsprotectcloud/reference/certificateretirement_recovercertificates)
505+
506+
[https://developer.venafi.com/tlsprotectcloud/reference/certificateretirement_retirecertificates](https://developer.venafi.com/tlsprotectcloud/reference/certificateretirement_retirecertificates)
507+
508+
[https://developer.venafi.com/tlsprotectcloud/reference/certificateretirement_deletecertificates](https://developer.venafi.com/tlsprotectcloud/reference/certificateretirement_deletecertificates)
509+
510+
[https://developer.venafi.com/tlsprotectcloud/reference/certificaterequests_create](https://developer.venafi.com/tlsprotectcloud/reference/certificaterequests_create)
460511
461-
[https://api.venafi.cloud/webjars/swagger-ui/index.html?urls.primaryName=outagedetection-service#/Certificates/certificateretirement_deleteCertificates](https://api.venafi.cloud/webjars/swagger-ui/index.html?urls.primaryName=outagedetection-service#/Certificates/certificateretirement_deleteCertificates)
512+
[https://developer.venafi.com/tlsprotectcloud/reference/certificates_validation](https://developer.venafi.com/tlsprotectcloud/reference/certificates_validation)
462513

0 commit comments

Comments
 (0)