Update manifest and docs to 6.5.0

Venafi · Oct 1, 2024 · 2a2258b · 2a2258b
1 parent cdcb381
commit 2a2258b
Show file tree

Hide file tree

Showing 37 changed files with 2,083 additions and 55 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,12 @@
+## 6.5.0
+- Merge all functions into 1 psm1 module.  This yields much better performance, especially when running multithreaded.
+- Add multithreading support on PS v5 with the Microsoft.PowerShell.ThreadJob module (installed separately).  If the module isn't installed, multithreading will be disabled.  Set `-ThrottleLimit` to 1 on the functions that support it to disable multithreading on PS v5 and v7.
+- Module now available in the GitHub release.  This is helpful for those without access to PowerShell Gallery, although that is the preferred option.
+- PSSodium, needed for several TLSPC functions for encryption, is no longer directly included in the module.  Install it from the Gallery.
+- The VenafiSession class has been deprecated and replaced with a PSCustomObject equivalent
+- Key based authentication on TLSPDC has been deprecated
+- Default `Invoke-VdcCertificateAction -Push` to push to all applications and added an example to override and push to specific applications
+
 ## 6.4.2
 - Add batching to `Invoke-VcCertificateAction` with progress and verbose logging.  Batches will be 1000 by default, but can be overridden with `-BatchSize`.  Also added better use of ShouldProcess.
 
@@ -718,5 +727,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: Greg Brownstein
 #
-# Generated on: 09/13/2024
+# Generated on: 10/01/2024
 #
 
 @{
@@ -12,7 +12,7 @@
 RootModule = 'VenafiPS.psm1'
 
 # Version number of this module.
-ModuleVersion = '6.5'
+ModuleVersion = '6.5.0'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()
@@ -57,11 +57,7 @@ PowerShellVersion = '5.1'
 # RequiredAssemblies = @()
 
 # Script files (.ps1) that are run in the caller's environment prior to importing this module.
-# ScriptsToProcess = 'Classes\TppPermission.ps1', 'Classes\VenafiSession.ps1',
-#                'Enum\TppCertificateStage.ps1', 'Enum\TppConfigResult.ps1',
-#                'Enum\TppEventSeverity.ps1', 'Enum\TppIdentityType.ps1',
-#                'Enum\TppManagementType.ps1', 'Enum\TppMetadataResult.ps1',
-#                'Enum\TppSecretStoreResult.ps1', 'Enum\TppWorkflowResult.ps1'
+# ScriptsToProcess = @()
 
 # Type files (.ps1xml) to be loaded when importing this module
 # TypesToProcess = @()

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,3 +1,12 @@
+## 6.5.0
+- Merge all functions into 1 psm1 module.  This yields much better performance, especially when running multithreaded.
+- Add multithreading support on PS v5 with the Microsoft.PowerShell.ThreadJob module (installed separately).  If the module isn't installed, multithreading will be disabled.  Set `-ThrottleLimit` to 1 on the functions that support it to disable multithreading on PS v5 and v7.
+- Module now available in the GitHub release.  This is helpful for those without access to PowerShell Gallery, although that is the preferred option.
+- PSSodium, needed for several TLSPC functions for encryption, is no longer directly included in the module.  Install it from the Gallery.
+- The VenafiSession class has been deprecated and replaced with a PSCustomObject equivalent
+- Key based authentication on TLSPDC has been deprecated
+- Default `Invoke-VdcCertificateAction -Push` to push to all applications and added an example to override and push to specific applications
+
 ## 6.4.2
 - Add batching to `Invoke-VcCertificateAction` with progress and verbose logging.  Batches will be 1000 by default, but can be overridden with `-BatchSize`.  Also added better use of ShouldProcess.
 
@@ -718,5 +727,6 @@ This is a major release.  Although every attempt has been made to be backwards c
 
 
 
+
 
 
diff --git a/docs/functions/ConvertTo-PlaintextString.md b/docs/functions/ConvertTo-PlaintextString.md
@@ -0,0 +1,64 @@
+# ConvertTo-PlaintextString
+
+## SYNOPSIS
+Convert a SecureString or PSCredential to a plaintext string/password.
+
+## SYNTAX
+
+```
+ConvertTo-PlaintextString [-InputObject] <PSObject> [-ProgressAction <ActionPreference>] [<CommonParameters>]
+```
+
+## DESCRIPTION
+{{ Fill in the Description }}
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+ConvertTo-PlaintextString -InputObject $mySecureString
+```
+
+## PARAMETERS
+
+### -InputObject
+{{ Fill InputObject Description }}
+
+```yaml
+Type: PSObject
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: True (ByPropertyName, ByValue)
+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
+
+## OUTPUTS
+
+### System.String
+## NOTES
+
+## RELATED LINKS
diff --git a/docs/functions/ConvertTo-UtcIso8601.md b/docs/functions/ConvertTo-UtcIso8601.md
@@ -0,0 +1,65 @@
+# ConvertTo-UtcIso8601
+
+## SYNOPSIS
+Convert datetime to UTC ISO 8601 format
+
+## SYNTAX
+
+```
+ConvertTo-UtcIso8601 [-InputObject] <DateTime> [-ProgressAction <ActionPreference>] [<CommonParameters>]
+```
+
+## DESCRIPTION
+Convert datetime to UTC ISO 8601 format
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+(get-date) | ConvertTo-UtcIso8601
+```
+
+## PARAMETERS
+
+### -InputObject
+DateTime object
+
+```yaml
+Type: DateTime
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: True (ByValue)
+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
+
+### InputObject
+## OUTPUTS
+
+### System.String
+## NOTES
+
+## RELATED LINKS
diff --git a/docs/functions/ConvertTo-VcTeam.md b/docs/functions/ConvertTo-VcTeam.md
@@ -0,0 +1,65 @@
+# ConvertTo-VcTeam
+
+## SYNOPSIS
+Convert vaas team to standard format
+
+## SYNTAX
+
+```
+ConvertTo-VcTeam [-InputObject] <PSObject[]> [-ProgressAction <ActionPreference>] [<CommonParameters>]
+```
+
+## DESCRIPTION
+Convert vaas team to standard format
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+$teamObj | ConvertTo-VcTeam
+```
+
+## PARAMETERS
+
+### -InputObject
+Team object
+
+```yaml
+Type: PSObject[]
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: True (ByValue)
+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
+
+### InputObject
+## OUTPUTS
+
+### PSCustomObject
+## NOTES
+
+## RELATED LINKS
diff --git a/docs/functions/ConvertTo-VdcFullPath.md b/docs/functions/ConvertTo-VdcFullPath.md
@@ -0,0 +1,67 @@
+# ConvertTo-VdcFullPath
+
+## SYNOPSIS
+{{ Fill in the Synopsis }}
+
+## SYNTAX
+
+```
+ConvertTo-VdcFullPath [-Path] <String> [-ProgressAction <ActionPreference>] [<CommonParameters>]
+```
+
+## DESCRIPTION
+{{ Fill in the Description }}
+
+## EXAMPLES
+
+### Example 1
+```powershell
+PS C:\> {{ Add example code here }}
+```
+
+{{ Add example description here }}
+
+## PARAMETERS
+
+### -Path
+{{ Fill Path Description }}
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 0
+Default value: None
+Accept pipeline input: True (ByValue)
+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
+
+### System.String
+## OUTPUTS
+
+### System.Object
+## NOTES
+
+## RELATED LINKS