Update manifest and docs to 5.3.0

Venafi · Jan 18, 2023 · 3fe28f3 · 3fe28f3
1 parent 4edb68b
commit 3fe28f3
Show file tree

Hide file tree

Showing 5 changed files with 164 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,10 @@
+## 5.3.0
+- Add `Remove-TppObject` to remove any object.  Multiple people have asked for this so it's been added, but be careful using it as it can be very destructive.  Recommend using -WhatIf to validate.
+- Fix `Invoke-VenafiCertificateAction` always running as verbose, [#173](https://github.com/Venafi/VenafiPS/issues/173)
+- Fix `Set-TppAttribute` error when providing a null value, [#176](https://github.com/Venafi/VenafiPS/issues/176)
+- Fix `Set-TppPermission` error when providing VenafiSession directly, [#174](https://github.com/Venafi/VenafiPS/issues/174)
+
+
 ## 5.2.2
 - Add specific event webhook subscription, not just types, and criticality option to `New-VaasConnector`
 - Fix `Get-TppObject` returning invalid parent path, [#166](https://github.com/Venafi/VenafiPS/issues/166)
@@ -488,5 +495,6 @@
 
 
 
+
 
 
diff --git a/VenafiPS/VenafiPS.psd1 b/VenafiPS/VenafiPS.psd1
@@ -3,7 +3,7 @@
 #
 # Generated by: Venafi
 #
-# Generated on: 11/30/2022
+# Generated on: 01/18/2023
 #
 
 @{
@@ -12,7 +12,7 @@
 RootModule = 'VenafiPS.psm1'
 
 # Version number of this module.
-ModuleVersion = '5.3'
+ModuleVersion = '5.3.0'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()
@@ -106,7 +106,8 @@ FunctionsToExport = 'Add-TppCertificateAssociation', 'Convert-TppObject',
                'Import-VaasCertificate', 'Get-VaasConnector', 'Remove-VaasConnector',
                'New-VaasConnector', 'Find-TppEngine', 'Get-TppEngineFolder',
                'Remove-TppEngineFolder', 'Add-TppEngineFolder', 'Revoke-TppGrant',
-               'Add-TppAdaptableHash', 'New-VaasCertificate', 'Find-VaasObject', 'Remove-TppObject'
+               'Add-TppAdaptableHash', 'New-VaasCertificate', 'Find-VaasObject',
+               'Remove-TppObject'
 
 # 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.
 CmdletsToExport = @()

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,3 +1,10 @@
+## 5.3.0
+- Add `Remove-TppObject` to remove any object.  Multiple people have asked for this so it's been added, but be careful using it as it can be very destructive.  Recommend using -WhatIf to validate.
+- Fix `Invoke-VenafiCertificateAction` always running as verbose, [#173](https://github.com/Venafi/VenafiPS/issues/173)
+- Fix `Set-TppAttribute` error when providing a null value, [#176](https://github.com/Venafi/VenafiPS/issues/176)
+- Fix `Set-TppPermission` error when providing VenafiSession directly, [#174](https://github.com/Venafi/VenafiPS/issues/174)
+
+
 ## 5.2.2
 - Add specific event webhook subscription, not just types, and criticality option to `New-VaasConnector`
 - Fix `Get-TppObject` returning invalid parent path, [#166](https://github.com/Venafi/VenafiPS/issues/166)
@@ -488,5 +495,6 @@
 
 
 
+
 
 
diff --git a/docs/functions/Remove-TppObject.md b/docs/functions/Remove-TppObject.md
@@ -0,0 +1,143 @@
+# Remove-TppObject
+
+## SYNOPSIS
+Remove TPP objects
+
+## SYNTAX
+
+```
+Remove-TppObject [-Path] <String> [-Recursive] [[-VenafiSession] <PSObject>] [-WhatIf] [-Confirm]
+ [<CommonParameters>]
+```
+
+## DESCRIPTION
+Remove a TPP object and optionally perform a recursive removal.
+This process can be very destructive as it will remove anything you send it!!!
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+Remove-TppObject -Path '\VED\Policy\My empty folder'
+Remove an object
+```
+
+### EXAMPLE 2
+```
+Remove-TppObject -Path '\VED\Policy\folder' -Recursive
+Remove an object and all objects contained
+```
+
+### EXAMPLE 3
+```
+Find-TppObject -Class 'capi' | Remove-TppObject
+Find 1 or more objects and remove them
+```
+
+### EXAMPLE 4
+```
+Remove-TppObject -Path '\VED\Policy\folder' -Confirm:$false
+Remove an object without prompting for confirmation.  Be careful!
+```
+
+## PARAMETERS
+
+### -Path
+Full path to an existing object
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: True
+Position: 1
+Default value: None
+Accept pipeline input: True (ByPropertyName)
+Accept wildcard characters: False
+```
+
+### -Recursive
+Remove recursively, eg.
+everything within a policy folder
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+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 TPP token can also provided.
+If providing a TPP token, an environment variable named TPP_SERVER must also be set.
+
+```yaml
+Type: PSObject
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 2
+Default value: $script:VenafiSession
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -WhatIf
+Shows what would happen if the cmdlet runs.
+The cmdlet is not run.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: wi
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Confirm
+Prompts you for confirmation before running the cmdlet.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases: cf
+
+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
+
+### Path
+## OUTPUTS
+
+### None
+## NOTES
+
+## RELATED LINKS
+
+[http://VenafiPS.readthedocs.io/en/latest/functions/Remove-TppObject/](http://VenafiPS.readthedocs.io/en/latest/functions/Remove-TppObject/)
+
+[https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/Remove-TppObject.ps1](https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/Remove-TppObject.ps1)
+
+[https://docs.venafi.com/Docs/currentSDK/TopNav/Content/SDK/WebSDK/r-SDK-POST-Config-delete.php](https://docs.venafi.com/Docs/currentSDK/TopNav/Content/SDK/WebSDK/r-SDK-POST-Config-delete.php)
+
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -93,6 +93,7 @@ nav:
     - Remove-TppCodeSignEnvironment: functions/Remove-TppCodeSignEnvironment.md
     - Remove-TppCodeSignProject: functions/Remove-TppCodeSignProject.md
     - Remove-TppEngineFolder: functions/Remove-TppEngineFolder.md
+    - Remove-TppObject: functions/Remove-TppObject.md
     - Remove-TppPermission: functions/Remove-TppPermission.md
     - Remove-VaasConnector: functions/Remove-VaasConnector.md
     - Remove-VenafiTeam: functions/Remove-VenafiTeam.md