From 1eb7108c4b8fd10fda2635a0ac85f19a50abc1c2 Mon Sep 17 00:00:00 2001 From: Greg Brownstein Date: Wed, 27 Mar 2024 00:44:27 +0000 Subject: [PATCH] Update manifest and docs to 6.3.1 --- CHANGELOG.md | 6 +++ VenafiPS/VenafiPS.psd1 | 4 +- docs/changelog.md | 6 +++ docs/functions/Get-VdcAttribute.md | 55 ++++++++++++++++++++++------ docs/functions/Get-VdcCertificate.md | 2 +- docs/functions/Search-VdcHistory.md | 2 +- 6 files changed, 59 insertions(+), 16 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ff1e342c..14482112 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,8 @@ +## 6.3.1 +- `Get-VdcAttribute` parallel enhancements to support input objects of -Path and not just -All. [#271](https://github.com/Venafi/VenafiPS/issues/271) +- Add `Get-VdcAttribute -ThrottleLimit` + + ## 6.3.0 - Add `Export-VcCertificate -PKCS12`, requires PowerShell v7.1+. [#251](https://github.com/Venafi/VenafiPS/issues/251) - Add `New-VenafiSession -TimeoutSec`, the default is 0 for no timeout. If using SecretManagement, store this with the other metadata. @@ -687,5 +692,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 index 36d597aa..67c493e1 100644 --- a/VenafiPS/VenafiPS.psd1 +++ b/VenafiPS/VenafiPS.psd1 @@ -3,7 +3,7 @@ # # Generated by: Greg Brownstein # -# Generated on: 03/20/2024 +# Generated on: 03/27/2024 # @{ @@ -12,7 +12,7 @@ RootModule = 'VenafiPS.psm1' # Version number of this module. -ModuleVersion = '6.3.0' +ModuleVersion = '6.3.1' # Supported PSEditions # CompatiblePSEditions = @() diff --git a/docs/changelog.md b/docs/changelog.md index ef7709a0..82cabb4d 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -1,3 +1,8 @@ +## 6.3.1 +- `Get-VdcAttribute` parallel enhancements to support input objects of -Path and not just -All. [#271](https://github.com/Venafi/VenafiPS/issues/271) +- Add `Get-VdcAttribute -ThrottleLimit` + + ## 6.3.0 - Add `Export-VcCertificate -PKCS12`, requires PowerShell v7.1+. [#251](https://github.com/Venafi/VenafiPS/issues/251) - Add `New-VenafiSession -TimeoutSec`, the default is 0 for no timeout. If using SecretManagement, store this with the other metadata. @@ -687,5 +692,6 @@ This is a major release. Although every attempt has been made to be backwards c + diff --git a/docs/functions/Get-VdcAttribute.md b/docs/functions/Get-VdcAttribute.md index 8584c4b8..5c561676 100644 --- a/docs/functions/Get-VdcAttribute.md +++ b/docs/functions/Get-VdcAttribute.md @@ -7,14 +7,14 @@ Get object attributes as well as policy attributes ### Attribute (Default) ``` -Get-VdcAttribute -Path -Attribute [-Class ] [-NoLookup] [-VenafiSession ] - [-ProgressAction ] [] +Get-VdcAttribute -Path -Attribute [-Class ] [-NoLookup] [-ThrottleLimit ] + [-VenafiSession ] [-ProgressAction ] [] ``` ### All ``` -Get-VdcAttribute -Path [-Class ] [-All] [-NoLookup] [-VenafiSession ] - [-ProgressAction ] [] +Get-VdcAttribute -Path [-Class ] [-All] [-NoLookup] [-ThrottleLimit ] + [-VenafiSession ] [-ProgressAction ] [] ``` ## DESCRIPTION @@ -151,6 +151,25 @@ Notification Disabled : 0 Retrieve all policy attributes for the specified policy folder and class +### EXAMPLE 8 +``` +Find-VdcCertificate | Get-VdcAttribute -Attribute Contact,'Managed By','Want Renewal' -ThrottleLimit 50 +``` + +Name : mycert +Path : \VED\Policy\mycert +TypeName : X509 Server Certificate +Guid : 1dc31664-a9f3-407c-8bf3-1e388e90a114 +Attribute : {@{Name=Contact; PolicyPath=\VED\Policy; Value=local:{ab2a2e32-b412-4466-b5b5-484478a99bf4}; Locked=False; Overridden=False}, @{Name=Managed By; PolicyPath=\VED\Policy; + Value=Aperture; Locked=True; Overridden=False}, @{Name=Want Renewal; PolicyPath=\VED\Policy; Value=0; Locked=True; Overridden=False}} +Contact : local:{ab2a2e32-b412-4466-b5b5-484478a99bf4} +Managed By : Aperture +Want Renewal : 0 +... + +Retrieve specific attributes for all certificates. +Throttle the number of threads to 50, the default is 100 + ## PARAMETERS ### -Path @@ -171,7 +190,7 @@ Accept wildcard characters: False ### -Attribute Only retrieve the value/values for this attribute. -For custom fields, you provided either the Guid or Label. +For custom fields, you can provide either the Guid or Label. ```yaml Type: String[] @@ -187,9 +206,9 @@ Accept wildcard characters: False ### -Class Get policy attributes instead of object attributes. -Provide the class name to retrieve the value for. +Provide the class name to retrieve the value(s) for. If unsure of the class name, add the value through the TLSPDC UI and go to Support-\>Policy Attributes to find it. -The Attribute property will contain the path where the policy was applied. +The Attribute property of the return object will contain the path where the policy was applied. ```yaml Type: String @@ -224,7 +243,7 @@ Accept wildcard characters: False Default functionality is to perform lookup of attributes names to see if they are custom fields or not. If they are, pass along the guid instead of name required by the api for custom fields. To override this behavior and use the attribute name as is, add -NoLookup. -Useful if on the off chance you have a custom field with the same name as a built-in attribute. +Useful if, on the off chance, you have a custom field with the same name as a built-in attribute. Can also be used with -All and the output will contain guids instead of looked up names. ```yaml @@ -239,6 +258,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ThrottleLimit +Limit the number of threads when running in parallel; the default is 100. +Applicable to PS v7+ only. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 100 +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. @@ -285,10 +320,6 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## RELATED LINKS -[http://VenafiPS.readthedocs.io/en/latest/functions/Get-VdcAttribute/](http://VenafiPS.readthedocs.io/en/latest/functions/Get-VdcAttribute/) - -[https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/Get-VdcAttribute.ps1](https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/Get-VdcAttribute.ps1) - [https://docs.venafi.com/Docs/currentSDK/TopNav/Content/SDK/WebSDK/r-SDK-POST-Config-findpolicy.php](https://docs.venafi.com/Docs/currentSDK/TopNav/Content/SDK/WebSDK/r-SDK-POST-Config-findpolicy.php) [https://docs.venafi.com/Docs/current/TopNav/Content/SDK/WebSDK/r-SDK-POST-Config-readeffectivepolicy.php](https://docs.venafi.com/Docs/current/TopNav/Content/SDK/WebSDK/r-SDK-POST-Config-readeffectivepolicy.php) diff --git a/docs/functions/Get-VdcCertificate.md b/docs/functions/Get-VdcCertificate.md index d5c450b8..00558fa3 100644 --- a/docs/functions/Get-VdcCertificate.md +++ b/docs/functions/Get-VdcCertificate.md @@ -50,7 +50,7 @@ Get certificate info for all certs ### EXAMPLE 3 ``` -Get-VdcCertificate -CertificateId '\ved\policy\mycert.com' -IncludeTppPreviousVersions +Get-VdcCertificate -CertificateId '\ved\policy\mycert.com' -IncludePreviousVersions ``` Get certificate info for a specific cert, including historical versions of the certificate. diff --git a/docs/functions/Search-VdcHistory.md b/docs/functions/Search-VdcHistory.md index 4c43609e..7826ab45 100644 --- a/docs/functions/Search-VdcHistory.md +++ b/docs/functions/Search-VdcHistory.md @@ -13,7 +13,7 @@ Search-VdcHistory [[-Path] ] [-Attribute] [[-VenafiSession] ## DESCRIPTION Items in the secret store matching the key/value provided will be found and their details returned with their associated 'current' item. As this function may return details on many items, optional parallel processing has been implemented. -Be sure to use PowerShell Core, v7 or greater, to take advantage. +Be sure to use PowerShell v7+ to take advantage. ## EXAMPLES