Update manifest and docs to 3.1.3 ***NO_CI***

Venafi · Jul 21, 2021 · c4812f9 · c4812f9
1 parent ce1ec62
commit c4812f9
Show file tree

Hide file tree

Showing 5 changed files with 64 additions and 38 deletions.
diff --git a/VenafiPS/VenafiPS.psd1 b/VenafiPS/VenafiPS.psd1
@@ -3,7 +3,7 @@
 #
 # Generated by: Greg Brownstein
 #
-# Generated on: 7/20/2021
+# Generated on: 7/21/2021
 #
 
 @{
@@ -12,7 +12,7 @@
 RootModule = 'VenafiPS.psm1'
 
 # Version number of this module.
-ModuleVersion = '3.1.2'
+ModuleVersion = '3.1.3'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,3 +1,6 @@
+## 3.1.3
+- Add `-Force` parameter to `Revoke-TppToken` and `Revoke-TppCertificate` to bypass confirmation prompt
+
 ## 3.1.2
 - Add `-EventId` parameter to `Read-TppLog` to filter by a specific event id.
 - Add EventId to `Read-TppLog` output.  The value matches the hex value seen in Event Definitions in TPP.

diff --git a/docs/functions/New-VenafiSession.md b/docs/functions/New-VenafiSession.md
@@ -197,7 +197,7 @@ Aliases:
 Required: True
 Position: Named
 Default value: None
-Accept pipeline input: True (ByPropertyName)
+Accept pipeline input: False
 Accept wildcard characters: False
 ```
 

diff --git a/docs/functions/Revoke-TppCertificate.md b/docs/functions/Revoke-TppCertificate.md
@@ -5,16 +5,9 @@ Revoke a certificate
 
 ## SYNTAX
 
-### ByObject (Default)
 ```
-Revoke-TppCertificate -InputObject <TppObject> [-Reason <Int32>] [-Comments <String>] [-Disable] [-Wait]
- [-VenafiSession <VenafiSession>] [-WhatIf] [-Confirm] [<CommonParameters>]
-```
-
-### ByPath
-```
-Revoke-TppCertificate -Path <String> [-Reason <Int32>] [-Comments <String>] [-Disable] [-Wait]
- [-VenafiSession <VenafiSession>] [-WhatIf] [-Confirm] [<CommonParameters>]
+Revoke-TppCertificate [-Path] <String> [[-Reason] <Int32>] [[-Comments] <String>] [-Disable] [-Wait] [-Force]
+ [[-VenafiSession] <VenafiSession>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -31,40 +24,32 @@ Revoke the certificate with a reason of the CA being compromised
 
 ### EXAMPLE 2
 ```
+$cert | Revoke-TppCertificate -Force
+```
+
+Revoke the certificate bypassing the confirmation prompt
+
+### EXAMPLE 3
+```
 Revoke-TppCertificate -Path '\VED\Policy\My folder\app.mycompany.com' -Reason 2 -Wait
 ```
 
 Revoke the certificate with a reason of the CA being compromised and wait for it to complete
 
 ## PARAMETERS
 
-### -InputObject
-TppObject which represents a certificate
-
-```yaml
-Type: TppObject
-Parameter Sets: ByObject
-Aliases:
-
-Required: True
-Position: Named
-Default value: None
-Accept pipeline input: True (ByValue)
-Accept wildcard characters: False
-```
-
 ### -Path
 Full path to a certificate
 
 ```yaml
 Type: String
-Parameter Sets: ByPath
+Parameter Sets: (All)
 Aliases: DN, CertificateDN
 
 Required: True
-Position: Named
+Position: 1
 Default value: None
-Accept pipeline input: True (ByValue)
+Accept pipeline input: True (ByPropertyName, ByValue)
 Accept wildcard characters: False
 ```
 
@@ -84,7 +69,7 @@ Parameter Sets: (All)
 Aliases:
 
 Required: False
-Position: Named
+Position: 2
 Default value: 0
 Accept pipeline input: False
 Accept wildcard characters: False
@@ -99,7 +84,7 @@ Parameter Sets: (All)
 Aliases:
 
 Required: False
-Position: Named
+Position: 3
 Default value: None
 Accept pipeline input: False
 Accept wildcard characters: False
@@ -137,6 +122,21 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -Force
+Bypass the confirmation prompt
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -VenafiSession
 Session object created from New-VenafiSession method. 
 The value defaults to the script session object $VenafiSession.
@@ -147,7 +147,7 @@ Parameter Sets: (All)
 Aliases:
 
 Required: False
-Position: Named
+Position: 4
 Default value: $script:VenafiSession
 Accept pipeline input: False
 Accept wildcard characters: False

diff --git a/docs/functions/Revoke-TppToken.md b/docs/functions/Revoke-TppToken.md
@@ -7,17 +7,18 @@ Revoke a token
 
 ### Session (Default)
 ```
-Revoke-TppToken [-VenafiSession <VenafiSession>] [-WhatIf] [-Confirm] [<CommonParameters>]
+Revoke-TppToken [-Force] [-VenafiSession <VenafiSession>] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ### AccessToken
 ```
-Revoke-TppToken -AuthServer <String> -AccessToken <PSCredential> [-WhatIf] [-Confirm] [<CommonParameters>]
+Revoke-TppToken -AuthServer <String> -AccessToken <PSCredential> [-Force] [-WhatIf] [-Confirm]
+ [<CommonParameters>]
 ```
 
 ### TppToken
 ```
-Revoke-TppToken -TppToken <PSObject> [-WhatIf] [-Confirm] [<CommonParameters>]
+Revoke-TppToken -TppToken <PSObject> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -31,10 +32,17 @@ This could be an access token retrieved from this module or from other means.
 Revoke-TppToken
 ```
 
-Revoke token stored in session variable from New-VenafiSession
+Revoke token stored in session variable $VenafiSession from New-VenafiSession
 
 ### EXAMPLE 2
 ```
+Revoke-TppToken -Force
+```
+
+Revoke token bypassing confirmation prompt
+
+### EXAMPLE 3
+```
 Revoke-TppToken -AuthServer venafi.company.com -AccessToken $cred
 ```
 
@@ -88,6 +96,21 @@ Accept pipeline input: True (ByValue)
 Accept wildcard characters: False
 ```
 
+### -Force
+Bypass the confirmation prompt
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -VenafiSession
 Session object created from New-VenafiSession method. 
 The value defaults to the script session object $VenafiSession.
@@ -143,7 +166,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ### TppToken
 ## OUTPUTS
 
-### Version
+### none
 ## NOTES
 
 ## RELATED LINKS