From cba3977bdd84047de4f3f23d0d83d26dd5fa3262 Mon Sep 17 00:00:00 2001 From: Greg Brownstein Date: Fri, 15 Jul 2022 10:51:27 +0000 Subject: [PATCH] Update manifest and docs to 4.6.2 --- CHANGELOG.md | 5 +++++ VenafiPS/VenafiPS.psd1 | 4 ++-- docs/changelog.md | 5 +++++ docs/functions/Set-TppAttribute.md | 32 +++++++++++++++--------------- 4 files changed, 28 insertions(+), 18 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3caf8577..27d8dc43 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,7 @@ +## 4.6.2 +- Fix `Set-TppAttribute` failing to set a custom field value on a policy, [#131](https://github.com/Venafi/VenafiPS/issues/131) + + ## 4.6.1 - Add validation and error handling in `Get-VenafiTeam` for invalid IDs, [#126](https://github.com/Venafi/VenafiPS/issues/126) - Add messaging and error handling in `Get-VenafiTeam` for local groups, [#127](https://github.com/Venafi/VenafiPS/issues/127) @@ -412,3 +416,4 @@ + diff --git a/VenafiPS/VenafiPS.psd1 b/VenafiPS/VenafiPS.psd1 index d41d8dd1..0cdb8b52 100644 --- a/VenafiPS/VenafiPS.psd1 +++ b/VenafiPS/VenafiPS.psd1 @@ -3,7 +3,7 @@ # # Generated by: Venafi # -# Generated on: 07/13/2022 +# Generated on: 07/15/2022 # @{ @@ -12,7 +12,7 @@ RootModule = 'VenafiPS.psm1' # Version number of this module. -ModuleVersion = '4.6.1' +ModuleVersion = '4.6.2' # Supported PSEditions # CompatiblePSEditions = @() diff --git a/docs/changelog.md b/docs/changelog.md index 6589ff51..a78f034a 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -1,3 +1,7 @@ +## 4.6.2 +- Fix `Set-TppAttribute` failing to set a custom field value on a policy, [#131](https://github.com/Venafi/VenafiPS/issues/131) + + ## 4.6.1 - Add validation and error handling in `Get-VenafiTeam` for invalid IDs, [#126](https://github.com/Venafi/VenafiPS/issues/126) - Add messaging and error handling in `Get-VenafiTeam` for local groups, [#127](https://github.com/Venafi/VenafiPS/issues/127) @@ -412,3 +416,4 @@ + diff --git a/docs/functions/Set-TppAttribute.md b/docs/functions/Set-TppAttribute.md index 83ffdc31..a9956d75 100644 --- a/docs/functions/Set-TppAttribute.md +++ b/docs/functions/Set-TppAttribute.md @@ -5,7 +5,7 @@ Sets a value on an objects attribute or policies (policy attributes) ## SYNTAX -### Object (Default) +### NotPolicy (Default) ``` Set-TppAttribute -Path -Attribute [-BypassValidation] [-VenafiSession ] [-WhatIf] [-Confirm] [] @@ -13,8 +13,8 @@ Set-TppAttribute -Path -Attribute [-BypassValidation] [-Ven ### Policy ``` -Set-TppAttribute -Path -Attribute [-Policy] -ClassName [-Lock] - [-VenafiSession ] [-WhatIf] [-Confirm] [] +Set-TppAttribute -Path -Attribute [-BypassValidation] [-Policy] -PolicyClass + [-Lock] [-VenafiSession ] [-WhatIf] [-Confirm] [] ``` ## DESCRIPTION @@ -29,7 +29,7 @@ You can also set policies (policy attributes). Set-TppAttribute -Path '\VED\Policy\My Folder\app.company.com' -Attribute @{'Consumers'='\VED\Policy\myappobject.company.com'} ``` -Set a value on an object +Set the value on an object ### EXAMPLE 2 ``` @@ -43,25 +43,25 @@ Clear the value on an object, reverting to policy if applicable Set-TppAttribute -Path '\VED\Policy\My Folder\app.company.com' -Attribute @{'My custom field Label'='new custom value'} ``` -Set value on custom field +Set the value on a custom field ### EXAMPLE 4 ``` Set-TppAttribute -Path '\VED\Policy\My Folder\app.company.com' -Attribute @{'My custom field Label'='new custom value'} -BypassValidation ``` -Set value on custom field bypassing field validation +Set the value on a custom field bypassing field validation ### EXAMPLE 5 ``` -Set-TppAttribute -Path '\VED\Policy\My Folder' -Policy -ClassName 'X509 Certificate' -Attribute @{'Notification Disabled'='0'} +Set-TppAttribute -Path '\VED\Policy\My Folder' -PolicyClass 'X509 Certificate' -Attribute @{'Notification Disabled'='0'} ``` Set a policy attribute ### EXAMPLE 6 ``` -Set-TppAttribute -Path '\VED\Policy\My Folder' -Policy -ClassName 'X509 Certificate' -Attribute @{'Notification Disabled'='0'} -Lock +Set-TppAttribute -Path '\VED\Policy\My Folder' -PolicyClass 'X509 Certificate' -Attribute @{'Notification Disabled'='0'} -Lock ``` Set a policy attribute and lock the value @@ -102,11 +102,11 @@ Accept wildcard characters: False ### -BypassValidation Bypass data validation. -Only appicable to custom fields. +Only applicable to custom fields. ```yaml Type: SwitchParameter -Parameter Sets: Object +Parameter Sets: (All) Aliases: Required: False @@ -124,22 +124,20 @@ Type: SwitchParameter Parameter Sets: Policy Aliases: -Required: True +Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -ClassName -Required when setting policy attributes. -Provide the class name to set 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. +### -PolicyClass +{{ Fill PolicyClass Description }} ```yaml Type: String Parameter Sets: Policy -Aliases: +Aliases: ClassName Required: True Position: Named @@ -232,6 +230,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable [https://docs.venafi.com/Docs/current/TopNav/Content/SDK/WebSDK/r-SDK-POST-Metadata-Set.php](https://docs.venafi.com/Docs/current/TopNav/Content/SDK/WebSDK/r-SDK-POST-Metadata-Set.php) +[https://docs.venafi.com/Docs/currentSDK/TopNav/Content/SDK/WebSDK/r-SDK-POST-Metadata-SetPolicy.php](https://docs.venafi.com/Docs/currentSDK/TopNav/Content/SDK/WebSDK/r-SDK-POST-Metadata-SetPolicy.php) + [https://docs.venafi.com/Docs/current/TopNav/Content/SDK/WebSDK/r-SDK-POST-Config-write.php](https://docs.venafi.com/Docs/current/TopNav/Content/SDK/WebSDK/r-SDK-POST-Config-write.php) [https://docs.venafi.com/Docs/current/TopNav/Content/SDK/WebSDK/r-SDK-POST-Config-writepolicy.php](https://docs.venafi.com/Docs/current/TopNav/Content/SDK/WebSDK/r-SDK-POST-Config-writepolicy.php)