Update manifest and docs to 4.3.0

Venafi · May 12, 2022 · d04fb3e · d04fb3e
1 parent 324c767
commit d04fb3e
Show file tree

Hide file tree

Showing 9 changed files with 252 additions and 141 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,14 @@
+## 4.3.0
+- Add new output format for `Get-TppAttribute` using the parameter `-New`.  Attributes will now be provided as object properties as opposed to individual objects for each property, which made it difficult to retrieve the value itself.  This new format is available for all ways of using the function including attribute, effective attribute, and policy retrieval.  This new format will become the default in the future.
+- Add `Get-TppAttribute -PolicyClass -All` to retrieve all policy attributes at once
+- Add `New-TppCertificate -WorkToDoTimeout` to override the global setting for a CA to issue/renew certificate
+- Add support for api limitation of 5k clients at a time when calling `Remove-TppClient`
+- Add support for VaaS user matching rules with `New-VenafiTeam`
+- Add setting common name, if not provided, as the object name in `New-TppCertificate`, [#110](https://github.com/Venafi/VenafiPS/issues/110)
+- Fix syntax error when using `New-TppCertificate -Csr`, [#111](https://github.com/Venafi/VenafiPS/issues/111)
+- `-Guid` has been deprecated from `Get-TppAttribute`
+
+
 ## 4.2.4
 - Add `Search-TppHistory` to find historical items by attribute value and their associated current item
 - Fix `Move-TppObject` not appending object name when moving multiple objects to a new folder and passed via pipeline
@@ -359,3 +370,4 @@
 
 
 
+
diff --git a/VenafiPS/VenafiPS.psd1 b/VenafiPS/VenafiPS.psd1
@@ -3,7 +3,7 @@
 #
 # Generated by: Venafi
 #
-# Generated on: 04/29/2022
+# Generated on: 05/12/2022
 #
 
 @{
@@ -12,7 +12,7 @@
 RootModule = 'VenafiPS.psm1'
 
 # Version number of this module.
-ModuleVersion = '4.3'
+ModuleVersion = '4.3.0'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()

diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,3 +1,14 @@
+## 4.3.0
+- Add new output format for `Get-TppAttribute` using the parameter `-New`.  Attributes will now be provided as object properties as opposed to individual objects for each property, which made it difficult to retrieve the value itself.  This new format is available for all ways of using the function including attribute, effective attribute, and policy retrieval.  This new format will become the default in the future.
+- Add `Get-TppAttribute -PolicyClass -All` to retrieve all policy attributes at once
+- Add `New-TppCertificate -WorkToDoTimeout` to override the global setting for a CA to issue/renew certificate
+- Add support for api limitation of 5k clients at a time when calling `Remove-TppClient`
+- Add support for VaaS user matching rules with `New-VenafiTeam`
+- Add setting common name, if not provided, as the object name in `New-TppCertificate`, [#110](https://github.com/Venafi/VenafiPS/issues/110)
+- Fix syntax error when using `New-TppCertificate -Csr`, [#111](https://github.com/Venafi/VenafiPS/issues/111)
+- `-Guid` has been deprecated from `Get-TppAttribute`
+
+
 ## 4.2.4
 - Add `Search-TppHistory` to find historical items by attribute value and their associated current item
 - Fix `Move-TppObject` not appending object name when moving multiple objects to a new folder and passed via pipeline
@@ -359,3 +370,4 @@
 
 
 
+
diff --git a/docs/functions/Get-TppAttribute.md b/docs/functions/Get-TppAttribute.md
@@ -7,37 +7,31 @@ Get object attributes as well as policies (policy attributes)
 
 ### ByPath (Default)
 ```
-Get-TppAttribute -Path <String> [-Attribute <String[]>] [-AsValue] [-VenafiSession <PSObject>]
+Get-TppAttribute -Path <String> [-Attribute <String[]>] [-AsValue] [-New] [-VenafiSession <PSObject>]
+ [<CommonParameters>]
+```
+
+### AllPolicyPath
+```
+Get-TppAttribute -Path <String> [-All] [-Policy] -PolicyClass <String> [-New] [-VenafiSession <PSObject>]
  [<CommonParameters>]
 ```
 
 ### PolicyPath
 ```
-Get-TppAttribute -Path <String> -Attribute <String[]> [-Policy] -ClassName <String> [-AsValue]
+Get-TppAttribute -Path <String> -Attribute <String[]> [-Policy] -PolicyClass <String> [-AsValue] [-New]
  [-VenafiSession <PSObject>] [<CommonParameters>]
 ```
 
 ### AllEffectivePath
 ```
-Get-TppAttribute -Path <String> [-All] [-AsValue] [-VenafiSession <PSObject>] [<CommonParameters>]
+Get-TppAttribute -Path <String> [-All] [-New] [-VenafiSession <PSObject>] [<CommonParameters>]
 ```
 
 ### EffectiveByPath
 ```
-Get-TppAttribute -Path <String> -Attribute <String[]> [-Effective] [-AsValue] [-VenafiSession <PSObject>]
- [<CommonParameters>]
-```
-
-### ByGuid
-```
-Get-TppAttribute -Guid <Guid> [-Attribute <String[]>] [-AsValue] [-VenafiSession <PSObject>]
- [<CommonParameters>]
-```
-
-### EffectiveByGuid
-```
-Get-TppAttribute -Guid <Guid> -Attribute <String[]> [-Effective] [-AsValue] [-VenafiSession <PSObject>]
- [<CommonParameters>]
+Get-TppAttribute -Path <String> -Attribute <String[]> [-Effective] [-AsValue] [-New]
+ [-VenafiSession <PSObject>] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -52,34 +46,95 @@ For more info on policies and how they are different than attributes, see https:
 
 ### EXAMPLE 1
 ```
-Get-TppAttribute -Path '\VED\Policy\My Folder\myapp.company.com'
-Retrieve all values for an object, excluding values assigned by policy
+Get-TppAttribute -Path '\VED\Policy\certificates\test.gdb.com' -New
 ```
 
+Name                                   : test.gdb.com
+Path                                   : \ved\policy\certificates\test.gdb.com
+TypeName                               : X509 Server Certificate
+Guid                                   : b7a7221b-e038-41d9-9d49-d7f45c1ca128
+Certificate Vault Id                   : @{Value=442493; CustomFieldName=; PolicyPath=}
+Consumers                              : @{Value=System.Object\[\]; CustomFieldName=; PolicyPath=}
+Created By                             : @{Value=WebAdmin; CustomFieldName=; PolicyPath=}
+
+Retrieve all values for an object, excluding values assigned by policy
+
 ### EXAMPLE 2
 ```
-Get-TppAttribute -Path '\VED\Policy\My Folder\myapp.company.com' -AttributeName 'driver name'
-Retrieve the value for a specific attribute
+Get-TppAttribute -Path '\VED\Policy\certificates\test.gdb.com' -Attribute 'Driver Name' -New
 ```
 
+Name        : test.gdb.com
+Path        : \ved\policy\certificates\test.gdb.com
+TypeName    : X509 Server Certificate
+Guid        : b7a7221b-e038-41d9-9d49-d7f45c1ca128
+Driver Name : @{Value=appx509certificate; CustomFieldName=; PolicyPath=}
+
+Retrieve the value for a specific attribute
+
 ### EXAMPLE 3
 ```
-Get-TppAttribute -Path '\VED\Policy\My Folder\myapp.company.com' -AttributeName 'Contact' -Effective
-Retrieve the effective value for a specific attribute
+Get-TppAttribute -Path '\VED\Policy\certificates\test.gdb.com' -AttributeName 'State' -Effective -New
 ```
 
+Name     : test.gdb.com
+Path     : \ved\policy\certificates\test.gdb.com
+TypeName : X509 Server Certificate
+Guid     : b7a7221b-e038-41d9-9d49-d7f45c1ca128
+State    : @{Value=UT; CustomFieldName=; PolicyPath=\VED\Policy\Certificates}
+
+Retrieve the effective (policy applied) value for a specific attribute.
+This not only returns the value, but also the path where the policy is applied.
+
 ### EXAMPLE 4
 ```
-Get-TppAttribute -Path '\VED\Policy\My Folder\myapp.company.com' -All
-Retrieve all effective values for an object
+Get-TppAttribute -Path '\VED\Policy\certificates\test.gdb.com' -All -New
 ```
 
+Name                 : test.gdb.com
+Path                 : \ved\policy\certificates\test.gdb.com
+TypeName             : X509 Server Certificate
+Guid                 : b7a7221b-e038-41d9-9d49-d7f45c1ca128
+Certificate Vault Id : @{Value=442493; CustomFieldName=; PolicyPath=}
+City                 : @{Value=Salt Lake City; CustomFieldName=; PolicyPath=\VED\Policy\Certificates}
+Consumers            : @{Value=System.Object\[\]; CustomFieldName=; PolicyPath=}
+Created By           : @{Value=WebAdmin; CustomFieldName=; PolicyPath=}
+State                : @{Value=UT; CustomFieldName=; PolicyPath=\VED\Policy\Certificates}
+
+Retrieve all effective values for an object
+
 ### EXAMPLE 5
 ```
-Get-TppAttribute -Path '\VED\Policy\My Folder' -Policy -Class 'X509 Certificate' -AttributeName 'Contact'
-Retrieve the policy attribute value for the specified policy folder
+Get-TppAttribute -Path '\VED\Policy\certificates' -PolicyClass 'X509 Certificate' -AttributeName 'State' -New
 ```
 
+Name            : certificates
+Path            : \ved\policy\certificates
+TypeName        : Policy
+Guid            : a91fc152-a9fb-4b49-a7ca-7014b14d73eb
+PolicyClassName : x509 certificate
+State           : UT
+
+Retrieve specific policy attribute values for the specified policy folder and class
+
+### EXAMPLE 6
+```
+Get-TppAttribute -Path '\VED\Policy\certificates' -PolicyClass 'X509 Certificate' -All -New
+```
+
+Name            : certificates
+Path            : \ved\policy\certificates
+TypeName        : Policy
+Guid            : a91fc152-a9fb-4b49-a7ca-7014b14d73eb
+PolicyClassName : x509 certificate
+City            : Salt Lake City
+Country         : US
+Management Type : Enrollment
+Organization    : Venafi, Inc.
+State           : UT
+
+Retrieve all policy attribute values for the specified policy folder and class
+
 ## PARAMETERS
 
 ### -Path
@@ -88,7 +143,7 @@ Just providing DN will return all attributes.
 
 ```yaml
 Type: String
-Parameter Sets: ByPath, PolicyPath, AllEffectivePath, EffectiveByPath
+Parameter Sets: (All)
 Aliases: DN
 
 Required: True
@@ -98,29 +153,12 @@ Accept pipeline input: True (ByPropertyName, ByValue)
 Accept wildcard characters: False
 ```
 
-### -Guid
-To be deprecated; use -Path instead.
-Object Guid. 
-Just providing Guid will return all attributes.
-
-```yaml
-Type: Guid
-Parameter Sets: ByGuid, EffectiveByGuid
-Aliases:
-
-Required: True
-Position: Named
-Default value: None
-Accept pipeline input: True (ByValue)
-Accept wildcard characters: False
-```
-
 ### -Attribute
 Only retrieve the value/values for this attribute
 
 ```yaml
 Type: String[]
-Parameter Sets: ByPath, ByGuid
+Parameter Sets: ByPath
 Aliases:
 
 Required: False
@@ -132,7 +170,7 @@ Accept wildcard characters: False
 
 ```yaml
 Type: String[]
-Parameter Sets: PolicyPath, EffectiveByPath, EffectiveByGuid
+Parameter Sets: PolicyPath, EffectiveByPath
 Aliases:
 
 Required: True
@@ -148,7 +186,7 @@ This is not applicable to policies, only objects.
 
 ```yaml
 Type: SwitchParameter
-Parameter Sets: EffectiveByPath, EffectiveByGuid
+Parameter Sets: EffectiveByPath
 Aliases: EffectivePolicy
 
 Required: True
@@ -166,7 +204,7 @@ Note, expect this to take longer than usual given the number of api calls.
 
 ```yaml
 Type: SwitchParameter
-Parameter Sets: AllEffectivePath
+Parameter Sets: AllPolicyPath, AllEffectivePath
 Aliases:
 
 Required: True
@@ -177,29 +215,30 @@ Accept wildcard characters: False
 ```
 
 ### -Policy
-Get policies (aka policy attributes) instead of object attributes
+Deprecated. 
+To retrieve policy attributes, just provide -PolicyClass.
 
 ```yaml
 Type: SwitchParameter
-Parameter Sets: PolicyPath
+Parameter Sets: AllPolicyPath, PolicyPath
 Aliases:
 
-Required: True
+Required: False
 Position: Named
 Default value: False
 Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -ClassName
-Required when getting policy attributes. 
+### -PolicyClass
+Get policies (aka policy attributes) instead of object attributes.
 Provide the class name to retrieve the value for.
 If unsure of the class name, add the value through the TPP UI and go to Support-\>Policy Attributes to find it.
 
 ```yaml
 Type: String
-Parameter Sets: PolicyPath
-Aliases:
+Parameter Sets: AllPolicyPath, PolicyPath
+Aliases: ClassName
 
 Required: True
 Position: Named
@@ -209,7 +248,23 @@ Accept wildcard characters: False
 ```
 
 ### -AsValue
-{{ Fill AsValue Description }}
+Deprecated. 
+No longer required with -New format.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: ByPath, PolicyPath, EffectiveByPath
+Aliases:
+
+Required: False
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -New
+New output format which returns 1 object with multiple properties instead of an object per property
 
 ```yaml
 Type: SwitchParameter
@@ -249,12 +304,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ### Path
 ## OUTPUTS
 
-### PSCustomObject with properties:
-### - Name
-### - Value
-### - PolicyPath (only applicable with -All)
-### - IsCustomField (not applicable to policies)
-### - CustomName (not applicable to policies)
+### PSCustomObject
 ## NOTES
 
 ## RELATED LINKS

diff --git a/docs/functions/Import-TppCertificate.md b/docs/functions/Import-TppCertificate.md
@@ -180,7 +180,7 @@ By using this parameter, this function will import, but use newest.
 Only import the certificate when no Certificate object exists with a past, present, or current version of the imported certificate.
 If a match is found between the Certificate object and imported certificate, activate the certificate with the most current 'Valid From' date.
 Archive the unused certificate, even if it is the imported certificate, to the History tab.
-See https://github.com/Venafi/VenafiPS/issues/88#issuecomment-600134145 for a flowchart of the reconciliation algorithm.
+See https://docs.venafi.com/Docs/currentSDK/TopNav/Content/CA/c-CA-Import-ReconciliationRules-tpp.php for a flowchart of the reconciliation algorithm.
 
 ```yaml
 Type: SwitchParameter