Update manifest and docs to 6.1.0

Venafi · Jan 7, 2024 · bbe7894 · bbe7894
1 parent e505a72
commit bbe7894
Show file tree

Hide file tree

Showing 13 changed files with 427 additions and 506 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+## 6.1.0
+- Add `Get-VcData` private function to centralize retrieving VC data for non search objects
+- Better messaging when VSats aren't available, [#242](https://github.com/Venafi/VenafiPS/issues/242)
+- Add messaging when PSSodium cannot be loaded, [#239](https://github.com/Venafi/VenafiPS/issues/239)
+- Add workaround for TLSPDC API failure when importing PKCS12
+
 ## 6.0.6
 - Fix incorrect path for Sodium in `Export-VcCertificate`, [#234](https://github.com/Venafi/VenafiPS/issues/234)
 
@@ -632,5 +638,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: 12/13/2023
+# Generated on: 01/07/2024
 #
 
 @{
@@ -12,7 +12,7 @@
 RootModule = 'VenafiPS.psm1'
 
 # Version number of this module.
-ModuleVersion = '6.1'
+ModuleVersion = '6.1.0'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,3 +1,9 @@
+## 6.1.0
+- Add `Get-VcData` private function to centralize retrieving VC data for non search objects
+- Better messaging when VSats aren't available, [#242](https://github.com/Venafi/VenafiPS/issues/242)
+- Add messaging when PSSodium cannot be loaded, [#239](https://github.com/Venafi/VenafiPS/issues/239)
+- Add workaround for TLSPDC API failure when importing PKCS12
+
 ## 6.0.6
 - Fix incorrect path for Sodium in `Export-VcCertificate`, [#234](https://github.com/Venafi/VenafiPS/issues/234)
 
@@ -632,5 +638,6 @@ This is a major release.  Although every attempt has been made to be backwards c
 
 
 
+
 
 
diff --git a/docs/functions/Add-VcTeamOwner.md b/docs/functions/Add-VcTeamOwner.md
@@ -6,7 +6,7 @@ Add owners to a team
 ## SYNTAX
 
 ```
-Add-VcTeamOwner [-ID] <String> [-Owner] <String[]> [[-VenafiSession] <PSObject>] [<CommonParameters>]
+Add-VcTeamOwner [-Team] <String> [-Owner] <String[]> [[-VenafiSession] <PSObject>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -16,21 +16,20 @@ Add owners to a TLSPC team
 
 ### EXAMPLE 1
 ```
-Add-VcTeamOwner -ID 'ca7ff555-88d2-4bfc-9efa-2630ac44c1f2' -Owner @('ca7ff555-88d2-4bfc-9efa-2630ac44c1f3', 'ca7ff555-88d2-4bfc-9efa-2630ac44c1f4')
+Add-VcTeamOwner -Team 'DevOps' -Owner @('ca7ff555-88d2-4bfc-9efa-2630ac44c1f3', 'ca7ff555-88d2-4bfc-9efa-2630ac44c1f4')
 ```
 
 Add owners
 
 ## PARAMETERS
 
-### -ID
-Team ID.
-This is the unique guid obtained from Get-VcTeam.
+### -Team
+Team ID or name
 
 ```yaml
 Type: String
 Parameter Sets: (All)
-Aliases: PrefixedUniversal, Guid
+Aliases: ID
 
 Required: True
 Position: 1
@@ -77,7 +76,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## INPUTS
 
-### ID
+### Team
 ## OUTPUTS
 
 ## NOTES

diff --git a/docs/functions/Export-VcCertificate.md b/docs/functions/Export-VcCertificate.md
@@ -1,7 +1,7 @@
 # Export-VcCertificate
 
 ## SYNOPSIS
-Export certificate data from TLSPC
+{{ Fill in the Synopsis }}
 
 ## SYNTAX
 
@@ -11,134 +11,104 @@ Export-VcCertificate [-ID] <String> [[-PrivateKeyPassword] <PSObject>] [-Include
 ```
 
 ## DESCRIPTION
-Export certificate data in PEM format. 
-You can retrieve the certificate, chain, and key.
+{{ Fill in the Description }}
 
 ## EXAMPLES
 
-### EXAMPLE 1
-```
-$certId | Export-VcCertificate
-```
-
-Export certificate data
-
-### EXAMPLE 2
-```
-$certId | Export-VcCertificate -PrivateKeyPassword 'myPassw0rd!'
+### Example 1
+```powershell
+PS C:\> {{ Add example code here }}
 ```
 
-Export certificate and private key data
-
-### EXAMPLE 3
-```
-$cert | Export-VcCertificate -OutPath '~/temp'
-```
-
-Get certificate data and save to a file
-
-### EXAMPLE 4
-```
-$cert | Export-VcCertificate -IncludeChain
-```
-
-Get certificate data with the certificate chain included.
+{{ Add example description here }}
 
 ## PARAMETERS
 
 ### -ID
-Certificate ID, also known as uuid. 
-Use Find-VcCertificate or Get-VcCertificate to determine the ID.
-You can pipe those functions as well.
+{{ Fill ID Description }}
 
 ```yaml
 Type: String
 Parameter Sets: (All)
 Aliases: certificateId
 
 Required: True
-Position: 1
+Position: 0
 Default value: None
 Accept pipeline input: True (ByPropertyName, ByValue)
 Accept wildcard characters: False
 ```
 
-### -PrivateKeyPassword
-Password required to include the private key.
-You can either provide a String, SecureString, or PSCredential.
+### -IncludeChain
+{{ Fill IncludeChain Description }}
 
 ```yaml
-Type: PSObject
+Type: SwitchParameter
 Parameter Sets: (All)
 Aliases:
 
 Required: False
-Position: 2
+Position: Named
 Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -IncludeChain
-Include the certificate chain with the exported certificate.
+### -OutPath
+{{ Fill OutPath Description }}
 
 ```yaml
-Type: SwitchParameter
+Type: String
 Parameter Sets: (All)
 Aliases:
 
 Required: False
-Position: Named
-Default value: False
+Position: 2
+Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -OutPath
-Folder path to save the certificate to. 
-The name of the file will be determined automatically.
-For each certificate a directory will be created in this folder with the format Name-ID.
+### -PrivateKeyPassword
+{{ Fill PrivateKeyPassword Description }}
 
 ```yaml
-Type: String
+Type: PSObject
 Parameter Sets: (All)
 Aliases:
 
 Required: False
-Position: 3
+Position: 1
 Default value: None
 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.
+{{ Fill ThrottleLimit Description }}
 
 ```yaml
 Type: Int32
 Parameter Sets: (All)
 Aliases:
 
 Required: False
-Position: 4
-Default value: 100
+Position: 3
+Default value: None
 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.
+{{ Fill VenafiSession Description }}
 
 ```yaml
 Type: PSObject
 Parameter Sets: (All)
 Aliases:
 
 Required: False
-Position: 5
+Position: 4
 Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False
@@ -149,10 +119,10 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 
 ## INPUTS
 
-### ID
+### System.String
 ## OUTPUTS
 
-### PSCustomObject
+### System.Object
 ## NOTES
 
 ## RELATED LINKS
diff --git a/docs/functions/Find-VcCertificate.md b/docs/functions/Find-VcCertificate.md
@@ -9,8 +9,9 @@ Find certificates in TLSPC
 ```
 Find-VcCertificate [-Name <String>] [-KeyLength <Int32>] [-Serial <String>] [-Fingerprint <String>]
  [-IsSelfSigned] [-Status <String[]>] [-ExpireBefore <DateTime>] [-ExpireAfter <DateTime>] [-Version <String>]
- [-SanDns <String>] [-Application <String>] [-Order <PSObject[]>] [-ApplicationDetail] [-OwnerDetail]
- [-First <Int32>] [-VenafiSession <PSObject>] [<CommonParameters>]
+ [-SanDns <String>] [-Application <String>] [-Tag <String[]>] [-CN <String>] [-Issuer <String>]
+ [-Order <PSObject[]>] [-ApplicationDetail] [-OwnerDetail] [-First <Int32>] [-VenafiSession <PSObject>]
+ [<CommonParameters>]
 ```
 
 ### Filter
@@ -267,6 +268,52 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -Tag
+One or more tags associated with the certificate.
+You can specify either just a tag name or name:value.
+
+```yaml
+Type: String[]
+Parameter Sets: All
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -CN
+Search for certificates where the subject CN matches all of part of the value
+
+```yaml
+Type: String
+Parameter Sets: All
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Issuer
+Search by issuer name
+
+```yaml
+Type: String
+Parameter Sets: All
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -Filter
 Array or multidimensional array of fields and values to filter on.
 Each array should be of the format @(field, comparison operator, value).

diff --git a/docs/functions/Get-VcTeam.md b/docs/functions/Get-VcTeam.md
@@ -7,7 +7,7 @@ Get team info
 
 ### ID
 ```
-Get-VcTeam [-ID] <String[]> [-VenafiSession <PSObject>] [<CommonParameters>]
+Get-VcTeam [-Team] <String[]> [-VenafiSession <PSObject>] [<CommonParameters>]
 ```
 
 ### All
@@ -44,13 +44,13 @@ Get info for all teams
 
 ## PARAMETERS
 
-### -ID
-Team name or guid.
+### -Team
+{{ Fill Team Description }}
 
 ```yaml
 Type: String[]
 Parameter Sets: ID
-Aliases: teamID, owningTeam, owningTeams, owningTeamId, ownedTeams
+Aliases: teamID, owningTeam, owningTeams, owningTeamId, ownedTeams, ID
 
 Required: True
 Position: 1