Skip to content

Commit

Permalink
Update manifest and docs to 6.3.1
Browse files Browse the repository at this point in the history
  • Loading branch information
gdbarron committed Mar 27, 2024
1 parent 9dc7bf9 commit 1eb7108
Show file tree
Hide file tree
Showing 6 changed files with 59 additions and 16 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -687,5 +692,6 @@ This is a major release. Although every attempt has been made to be backwards c






4 changes: 2 additions & 2 deletions VenafiPS/VenafiPS.psd1
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
#
# Generated by: Greg Brownstein
#
# Generated on: 03/20/2024
# Generated on: 03/27/2024
#

@{
Expand All @@ -12,7 +12,7 @@
RootModule = 'VenafiPS.psm1'

# Version number of this module.
ModuleVersion = '6.3.0'
ModuleVersion = '6.3.1'

# Supported PSEditions
# CompatiblePSEditions = @()
Expand Down
6 changes: 6 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -687,5 +692,6 @@ This is a major release. Although every attempt has been made to be backwards c






55 changes: 43 additions & 12 deletions docs/functions/Get-VdcAttribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ Get object attributes as well as policy attributes

### Attribute (Default)
```
Get-VdcAttribute -Path <String> -Attribute <String[]> [-Class <String>] [-NoLookup] [-VenafiSession <PSObject>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-VdcAttribute -Path <String> -Attribute <String[]> [-Class <String>] [-NoLookup] [-ThrottleLimit <Int32>]
[-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### All
```
Get-VdcAttribute -Path <String> [-Class <String>] [-All] [-NoLookup] [-VenafiSession <PSObject>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
Get-VdcAttribute -Path <String> [-Class <String>] [-All] [-NoLookup] [-ThrottleLimit <Int32>]
[-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -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
Expand All @@ -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[]
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand Down Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/functions/Get-VdcCertificate.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/functions/Search-VdcHistory.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Search-VdcHistory [[-Path] <String>] [-Attribute] <Hashtable> [[-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

Expand Down

0 comments on commit 1eb7108

Please sign in to comment.