From 1662960a2145f713cc31489f41a9123cacb0f384 Mon Sep 17 00:00:00 2001 From: Greg Brownstein Date: Fri, 17 Jun 2022 17:42:05 +0000 Subject: [PATCH] Update manifest and docs to 4.5.0 --- CHANGELOG.md | 9 +++++ VenafiPS/VenafiPS.psd1 | 4 +-- docs/changelog.md | 9 +++++ .../Add-TppCertificateAssociation.md | 2 +- docs/functions/Add-VenafiTeamMember.md | 2 +- docs/functions/Add-VenafiTeamOwner.md | 2 +- docs/functions/Convert-TppObject.md | 2 +- docs/functions/ConvertTo-TppGuid.md | 2 +- docs/functions/ConvertTo-TppPath.md | 2 +- docs/functions/Export-VenafiCertificate.md | 2 +- docs/functions/Find-TppClient.md | 2 +- docs/functions/Find-TppCodeSignEnvironment.md | 2 +- docs/functions/Find-TppCodeSignProject.md | 2 +- docs/functions/Find-TppCodeSignTemplate.md | 2 +- docs/functions/Find-TppIdentity.md | 2 +- docs/functions/Find-TppObject.md | 2 +- docs/functions/Find-TppVaultId.md | 2 +- docs/functions/Find-VenafiCertificate.md | 2 +- docs/functions/Get-TppAttribute.md | 2 +- docs/functions/Get-TppCodeSignConfig.md | 2 +- docs/functions/Get-TppCodeSignEnvironment.md | 2 +- docs/functions/Get-TppCodeSignProject.md | 2 +- docs/functions/Get-TppCredential.md | 2 +- docs/functions/Get-TppCustomField.md | 2 +- docs/functions/Get-TppIdentityAttribute.md | 2 +- docs/functions/Get-TppObject.md | 2 +- docs/functions/Get-TppPermission.md | 2 +- docs/functions/Get-TppSystemStatus.md | 2 +- docs/functions/Get-TppVersion.md | 2 +- docs/functions/Get-TppWorkflowTicket.md | 2 +- docs/functions/Get-VenafiCertificate.md | 2 +- docs/functions/Get-VenafiIdentity.md | 2 +- docs/functions/Get-VenafiTeam.md | 2 +- docs/functions/Import-TppCertificate.md | 2 +- docs/functions/Invoke-TppCertificatePush.md | 2 +- .../Invoke-VenafiCertificateAction.md | 2 +- docs/functions/Move-TppObject.md | 2 +- docs/functions/New-TppCapiApplication.md | 2 +- docs/functions/New-TppCertificate.md | 2 +- docs/functions/New-TppCodeSignProject.md | 2 +- docs/functions/New-TppCustomField.md | 2 +- docs/functions/New-TppDevice.md | 2 +- docs/functions/New-TppObject.md | 2 +- docs/functions/New-TppPolicy.md | 2 +- docs/functions/New-VenafiTeam.md | 2 +- docs/functions/Read-VenafiLog.md | 2 +- docs/functions/Remove-TppCertificate.md | 2 +- .../Remove-TppCertificateAssociation.md | 2 +- docs/functions/Remove-TppClient.md | 2 +- .../Remove-TppCodeSignEnvironment.md | 2 +- docs/functions/Remove-TppCodeSignProject.md | 2 +- docs/functions/Remove-TppPermission.md | 2 +- docs/functions/Remove-VenafiTeam.md | 2 +- docs/functions/Remove-VenafiTeamMember.md | 2 +- docs/functions/Remove-VenafiTeamOwner.md | 2 +- docs/functions/Rename-TppObject.md | 2 +- docs/functions/Revoke-TppCertificate.md | 2 +- docs/functions/Revoke-TppToken.md | 2 +- docs/functions/Search-TppHistory.md | 2 +- docs/functions/Set-TppAttribute.md | 33 +++++++++++++------ .../functions/Set-TppCodeSignProjectStatus.md | 2 +- docs/functions/Set-TppCredential.md | 2 +- docs/functions/Set-TppPermission.md | 2 +- docs/functions/Set-TppWorkflowTicketStatus.md | 2 +- docs/functions/Test-TppIdentity.md | 2 +- docs/functions/Test-TppObject.md | 2 +- docs/functions/Write-TppLog.md | 2 +- 67 files changed, 106 insertions(+), 75 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 8ec5de40..6f818279 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,11 @@ +## 4.5.0 +- Add docker image with each new build and [publish to dockerhub](https://hub.docker.com/repository/docker/venafi/venafips-module). Add the below environment variables recognition for use with docker image, but could be used outside of it as well. This is great for ci/cd scenarios and more. + - TPP_SERVER - TPP server url + - TPP_TOKEN - TPP oauth token + - VAAS_KEY - VaaS key +- Fix `Set-TppAttribute` not clearing a value. You can now pass $null to clear an object's attribute value, [#119](https://github.com/Venafi/VenafiPS/issues/119) + + ## 4.4.0 - Add `New-VaasApplication` to create a new application on VaaS - Add `Get-VaasIssuingTemplate` to retrieve 1 or all certificate issuing templates on VaaS @@ -379,3 +387,4 @@ + diff --git a/VenafiPS/VenafiPS.psd1 b/VenafiPS/VenafiPS.psd1 index 13f246d9..57a8ef49 100644 --- a/VenafiPS/VenafiPS.psd1 +++ b/VenafiPS/VenafiPS.psd1 @@ -3,7 +3,7 @@ # # Generated by: Venafi # -# Generated on: 05/25/2022 +# Generated on: 06/17/2022 # @{ @@ -12,7 +12,7 @@ RootModule = 'VenafiPS.psm1' # Version number of this module. -ModuleVersion = '4.5' +ModuleVersion = '4.5.0' # Supported PSEditions # CompatiblePSEditions = @() diff --git a/docs/changelog.md b/docs/changelog.md index d09c56f8..00df9489 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -1,3 +1,11 @@ +## 4.5.0 +- Add docker image with each new build and [publish to dockerhub](https://hub.docker.com/repository/docker/venafi/venafips-module). Add the below environment variables recognition for use with docker image, but could be used outside of it as well. This is great for ci/cd scenarios and more. + - TPP_SERVER - TPP server url + - TPP_TOKEN - TPP oauth token + - VAAS_KEY - VaaS key +- Fix `Set-TppAttribute` not clearing a value. You can now pass $null to clear an object's attribute value, [#119](https://github.com/Venafi/VenafiPS/issues/119) + + ## 4.4.0 - Add `New-VaasApplication` to create a new application on VaaS - Add `Get-VaasIssuingTemplate` to retrieve 1 or all certificate issuing templates on VaaS @@ -379,3 +387,4 @@ + diff --git a/docs/functions/Add-TppCertificateAssociation.md b/docs/functions/Add-TppCertificateAssociation.md index ebf26949..ba09ff1c 100644 --- a/docs/functions/Add-TppCertificateAssociation.md +++ b/docs/functions/Add-TppCertificateAssociation.md @@ -103,7 +103,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Add-VenafiTeamMember.md b/docs/functions/Add-VenafiTeamMember.md index dc25053c..20bff630 100644 --- a/docs/functions/Add-VenafiTeamMember.md +++ b/docs/functions/Add-VenafiTeamMember.md @@ -68,7 +68,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Add-VenafiTeamOwner.md b/docs/functions/Add-VenafiTeamOwner.md index 73fb393e..d69b653d 100644 --- a/docs/functions/Add-VenafiTeamOwner.md +++ b/docs/functions/Add-VenafiTeamOwner.md @@ -68,7 +68,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Convert-TppObject.md b/docs/functions/Convert-TppObject.md index ebe53248..02adc91b 100644 --- a/docs/functions/Convert-TppObject.md +++ b/docs/functions/Convert-TppObject.md @@ -86,7 +86,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/ConvertTo-TppGuid.md b/docs/functions/ConvertTo-TppGuid.md index f4776bcf..e5f58e94 100644 --- a/docs/functions/ConvertTo-TppGuid.md +++ b/docs/functions/ConvertTo-TppGuid.md @@ -55,7 +55,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/ConvertTo-TppPath.md b/docs/functions/ConvertTo-TppPath.md index 1358d530..43215afc 100644 --- a/docs/functions/ConvertTo-TppPath.md +++ b/docs/functions/ConvertTo-TppPath.md @@ -55,7 +55,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Export-VenafiCertificate.md b/docs/functions/Export-VenafiCertificate.md index 3b211c42..9d3d7ddc 100644 --- a/docs/functions/Export-VenafiCertificate.md +++ b/docs/functions/Export-VenafiCertificate.md @@ -227,7 +227,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Find-TppClient.md b/docs/functions/Find-TppClient.md index 7b803ffd..95a05f21 100644 --- a/docs/functions/Find-TppClient.md +++ b/docs/functions/Find-TppClient.md @@ -48,7 +48,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Find-TppCodeSignEnvironment.md b/docs/functions/Find-TppCodeSignEnvironment.md index 66d1cf81..1dc99161 100644 --- a/docs/functions/Find-TppCodeSignEnvironment.md +++ b/docs/functions/Find-TppCodeSignEnvironment.md @@ -54,7 +54,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Find-TppCodeSignProject.md b/docs/functions/Find-TppCodeSignProject.md index 5513e90e..124b8ab0 100644 --- a/docs/functions/Find-TppCodeSignProject.md +++ b/docs/functions/Find-TppCodeSignProject.md @@ -53,7 +53,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Find-TppCodeSignTemplate.md b/docs/functions/Find-TppCodeSignTemplate.md index 70419e33..7c7a639f 100644 --- a/docs/functions/Find-TppCodeSignTemplate.md +++ b/docs/functions/Find-TppCodeSignTemplate.md @@ -53,7 +53,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Find-TppIdentity.md b/docs/functions/Find-TppIdentity.md index d137d53e..920e3dcd 100644 --- a/docs/functions/Find-TppIdentity.md +++ b/docs/functions/Find-TppIdentity.md @@ -131,7 +131,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Find-TppObject.md b/docs/functions/Find-TppObject.md index cadd0ceb..1fa6925e 100644 --- a/docs/functions/Find-TppObject.md +++ b/docs/functions/Find-TppObject.md @@ -190,7 +190,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Find-TppVaultId.md b/docs/functions/Find-TppVaultId.md index e197e565..32894379 100644 --- a/docs/functions/Find-TppVaultId.md +++ b/docs/functions/Find-TppVaultId.md @@ -42,7 +42,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Find-VenafiCertificate.md b/docs/functions/Find-VenafiCertificate.md index 1eca0aa0..8633dfe8 100644 --- a/docs/functions/Find-VenafiCertificate.md +++ b/docs/functions/Find-VenafiCertificate.md @@ -841,7 +841,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Get-TppAttribute.md b/docs/functions/Get-TppAttribute.md index 9025950e..65259aa1 100644 --- a/docs/functions/Get-TppAttribute.md +++ b/docs/functions/Get-TppAttribute.md @@ -282,7 +282,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Get-TppCodeSignConfig.md b/docs/functions/Get-TppCodeSignConfig.md index b8f7a239..0f00b29f 100644 --- a/docs/functions/Get-TppCodeSignConfig.md +++ b/docs/functions/Get-TppCodeSignConfig.md @@ -27,7 +27,7 @@ Get settings Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Get-TppCodeSignEnvironment.md b/docs/functions/Get-TppCodeSignEnvironment.md index ef15dda4..57fabce6 100644 --- a/docs/functions/Get-TppCodeSignEnvironment.md +++ b/docs/functions/Get-TppCodeSignEnvironment.md @@ -47,7 +47,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Get-TppCodeSignProject.md b/docs/functions/Get-TppCodeSignProject.md index 05e51878..9e2becff 100644 --- a/docs/functions/Get-TppCodeSignProject.md +++ b/docs/functions/Get-TppCodeSignProject.md @@ -47,7 +47,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Get-TppCredential.md b/docs/functions/Get-TppCredential.md index f908e964..5ab94218 100644 --- a/docs/functions/Get-TppCredential.md +++ b/docs/functions/Get-TppCredential.md @@ -42,7 +42,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Get-TppCustomField.md b/docs/functions/Get-TppCustomField.md index 2a7b61c2..29a56d2a 100644 --- a/docs/functions/Get-TppCustomField.md +++ b/docs/functions/Get-TppCustomField.md @@ -41,7 +41,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Get-TppIdentityAttribute.md b/docs/functions/Get-TppIdentityAttribute.md index 918f7af2..f072c9d2 100644 --- a/docs/functions/Get-TppIdentityAttribute.md +++ b/docs/functions/Get-TppIdentityAttribute.md @@ -66,7 +66,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Get-TppObject.md b/docs/functions/Get-TppObject.md index 8883ace6..e87a39c2 100644 --- a/docs/functions/Get-TppObject.md +++ b/docs/functions/Get-TppObject.md @@ -71,7 +71,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Get-TppPermission.md b/docs/functions/Get-TppPermission.md index 0db04346..8571665f 100644 --- a/docs/functions/Get-TppPermission.md +++ b/docs/functions/Get-TppPermission.md @@ -151,7 +151,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Get-TppSystemStatus.md b/docs/functions/Get-TppSystemStatus.md index 38658081..6f80cd9b 100644 --- a/docs/functions/Get-TppSystemStatus.md +++ b/docs/functions/Get-TppSystemStatus.md @@ -26,7 +26,7 @@ Get the status Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Get-TppVersion.md b/docs/functions/Get-TppVersion.md index c4274fdc..5eae8e29 100644 --- a/docs/functions/Get-TppVersion.md +++ b/docs/functions/Get-TppVersion.md @@ -26,7 +26,7 @@ Get the version Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Get-TppWorkflowTicket.md b/docs/functions/Get-TppWorkflowTicket.md index 1d06fb7c..5b7b5468 100644 --- a/docs/functions/Get-TppWorkflowTicket.md +++ b/docs/functions/Get-TppWorkflowTicket.md @@ -88,7 +88,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Get-VenafiCertificate.md b/docs/functions/Get-VenafiCertificate.md index 42f7874c..a02b00d4 100644 --- a/docs/functions/Get-VenafiCertificate.md +++ b/docs/functions/Get-VenafiCertificate.md @@ -133,7 +133,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Get-VenafiIdentity.md b/docs/functions/Get-VenafiIdentity.md index afa03d23..cde4b513 100644 --- a/docs/functions/Get-VenafiIdentity.md +++ b/docs/functions/Get-VenafiIdentity.md @@ -164,7 +164,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Get-VenafiTeam.md b/docs/functions/Get-VenafiTeam.md index 6bb6c19d..bc27a024 100644 --- a/docs/functions/Get-VenafiTeam.md +++ b/docs/functions/Get-VenafiTeam.md @@ -88,7 +88,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Import-TppCertificate.md b/docs/functions/Import-TppCertificate.md index f0c7c44a..619a60b1 100644 --- a/docs/functions/Import-TppCertificate.md +++ b/docs/functions/Import-TppCertificate.md @@ -213,7 +213,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Invoke-TppCertificatePush.md b/docs/functions/Invoke-TppCertificatePush.md index 41fca1d3..edfad5c3 100644 --- a/docs/functions/Invoke-TppCertificatePush.md +++ b/docs/functions/Invoke-TppCertificatePush.md @@ -71,7 +71,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Invoke-VenafiCertificateAction.md b/docs/functions/Invoke-VenafiCertificateAction.md index fe3c6760..fdb8170f 100644 --- a/docs/functions/Invoke-VenafiCertificateAction.md +++ b/docs/functions/Invoke-VenafiCertificateAction.md @@ -192,7 +192,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Move-TppObject.md b/docs/functions/Move-TppObject.md index 43487e95..e8f98a2a 100644 --- a/docs/functions/Move-TppObject.md +++ b/docs/functions/Move-TppObject.md @@ -65,7 +65,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/New-TppCapiApplication.md b/docs/functions/New-TppCapiApplication.md index 9f5e09ae..eb5f8f3d 100644 --- a/docs/functions/New-TppCapiApplication.md +++ b/docs/functions/New-TppCapiApplication.md @@ -305,7 +305,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/New-TppCertificate.md b/docs/functions/New-TppCertificate.md index e7c86a9a..9711171b 100644 --- a/docs/functions/New-TppCertificate.md +++ b/docs/functions/New-TppCertificate.md @@ -343,7 +343,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/New-TppCodeSignProject.md b/docs/functions/New-TppCodeSignProject.md index 0278b301..d5269b33 100644 --- a/docs/functions/New-TppCodeSignProject.md +++ b/docs/functions/New-TppCodeSignProject.md @@ -41,7 +41,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/New-TppCustomField.md b/docs/functions/New-TppCustomField.md index 113dfaa2..46749058 100644 --- a/docs/functions/New-TppCustomField.md +++ b/docs/functions/New-TppCustomField.md @@ -304,7 +304,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/New-TppDevice.md b/docs/functions/New-TppDevice.md index 51e8481b..7cd5e71b 100644 --- a/docs/functions/New-TppDevice.md +++ b/docs/functions/New-TppDevice.md @@ -126,7 +126,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/New-TppObject.md b/docs/functions/New-TppObject.md index a1ff9058..dcb4cfb8 100644 --- a/docs/functions/New-TppObject.md +++ b/docs/functions/New-TppObject.md @@ -118,7 +118,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/New-TppPolicy.md b/docs/functions/New-TppPolicy.md index 539f8d02..983e343e 100644 --- a/docs/functions/New-TppPolicy.md +++ b/docs/functions/New-TppPolicy.md @@ -78,7 +78,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/New-VenafiTeam.md b/docs/functions/New-VenafiTeam.md index 69ce1d58..3ac0370a 100644 --- a/docs/functions/New-VenafiTeam.md +++ b/docs/functions/New-VenafiTeam.md @@ -245,7 +245,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Read-VenafiLog.md b/docs/functions/Read-VenafiLog.md index c1c7c261..3b11831e 100644 --- a/docs/functions/Read-VenafiLog.md +++ b/docs/functions/Read-VenafiLog.md @@ -277,7 +277,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Remove-TppCertificate.md b/docs/functions/Remove-TppCertificate.md index fe33f774..3ec8aced 100644 --- a/docs/functions/Remove-TppCertificate.md +++ b/docs/functions/Remove-TppCertificate.md @@ -70,7 +70,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Remove-TppCertificateAssociation.md b/docs/functions/Remove-TppCertificateAssociation.md index 5d86ddc8..e5f1cedc 100644 --- a/docs/functions/Remove-TppCertificateAssociation.md +++ b/docs/functions/Remove-TppCertificateAssociation.md @@ -136,7 +136,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Remove-TppClient.md b/docs/functions/Remove-TppClient.md index d42cd50d..1ba87462 100644 --- a/docs/functions/Remove-TppClient.md +++ b/docs/functions/Remove-TppClient.md @@ -66,7 +66,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Remove-TppCodeSignEnvironment.md b/docs/functions/Remove-TppCodeSignEnvironment.md index 928425ce..90294a0f 100644 --- a/docs/functions/Remove-TppCodeSignEnvironment.md +++ b/docs/functions/Remove-TppCodeSignEnvironment.md @@ -49,7 +49,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Remove-TppCodeSignProject.md b/docs/functions/Remove-TppCodeSignProject.md index 13e6c380..3e8b851c 100644 --- a/docs/functions/Remove-TppCodeSignProject.md +++ b/docs/functions/Remove-TppCodeSignProject.md @@ -49,7 +49,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Remove-TppPermission.md b/docs/functions/Remove-TppPermission.md index b5a5580d..db5f4244 100644 --- a/docs/functions/Remove-TppPermission.md +++ b/docs/functions/Remove-TppPermission.md @@ -87,7 +87,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Remove-VenafiTeam.md b/docs/functions/Remove-VenafiTeam.md index b98d36e2..f85b3c29 100644 --- a/docs/functions/Remove-VenafiTeam.md +++ b/docs/functions/Remove-VenafiTeam.md @@ -55,7 +55,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Remove-VenafiTeamMember.md b/docs/functions/Remove-VenafiTeamMember.md index 18df6e0e..88eaac47 100644 --- a/docs/functions/Remove-VenafiTeamMember.md +++ b/docs/functions/Remove-VenafiTeamMember.md @@ -76,7 +76,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Remove-VenafiTeamOwner.md b/docs/functions/Remove-VenafiTeamOwner.md index 71e87ab1..e18596f5 100644 --- a/docs/functions/Remove-VenafiTeamOwner.md +++ b/docs/functions/Remove-VenafiTeamOwner.md @@ -76,7 +76,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Rename-TppObject.md b/docs/functions/Rename-TppObject.md index 21ff2a99..4c81a2e5 100644 --- a/docs/functions/Rename-TppObject.md +++ b/docs/functions/Rename-TppObject.md @@ -62,7 +62,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Revoke-TppCertificate.md b/docs/functions/Revoke-TppCertificate.md index 7c54e128..8176aed7 100644 --- a/docs/functions/Revoke-TppCertificate.md +++ b/docs/functions/Revoke-TppCertificate.md @@ -138,7 +138,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Revoke-TppToken.md b/docs/functions/Revoke-TppToken.md index 689b9879..34abdf64 100644 --- a/docs/functions/Revoke-TppToken.md +++ b/docs/functions/Revoke-TppToken.md @@ -112,7 +112,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Search-TppHistory.md b/docs/functions/Search-TppHistory.md index 3ad2b5d5..bbac2e8f 100644 --- a/docs/functions/Search-TppHistory.md +++ b/docs/functions/Search-TppHistory.md @@ -77,7 +77,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Set-TppAttribute.md b/docs/functions/Set-TppAttribute.md index 20ba024b..83ffdc31 100644 --- a/docs/functions/Set-TppAttribute.md +++ b/docs/functions/Set-TppAttribute.md @@ -27,33 +27,45 @@ You can also set policies (policy attributes). ### EXAMPLE 1 ``` Set-TppAttribute -Path '\VED\Policy\My Folder\app.company.com' -Attribute @{'Consumers'='\VED\Policy\myappobject.company.com'} -Set a value on an object ``` +Set a value on an object + ### EXAMPLE 2 ``` -Set-TppAttribute -Path '\VED\Policy\My Folder\app.company.com' -Attribute @{'My custom field Label'='new custom value'} -Set value on custom field +Set-TppAttribute -Path '\VED\Policy\My Folder\app.company.com' -Attribute @{'Management Type'=$null} ``` +Clear the value on an object, reverting to policy if applicable + ### EXAMPLE 3 ``` -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-TppAttribute -Path '\VED\Policy\My Folder\app.company.com' -Attribute @{'My custom field Label'='new custom value'} ``` +Set value on custom field + ### EXAMPLE 4 ``` -Set-TppAttribute -Path '\VED\Policy\My Folder' -Policy -ClassName 'X509 Certificate' -Attribute @{'Notification Disabled'='0'} -Set a policy attribute +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 + ### EXAMPLE 5 ``` +Set-TppAttribute -Path '\VED\Policy\My Folder' -Policy -ClassName '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 a policy attribute and lock the value ``` +Set a policy attribute and lock the value + ## PARAMETERS ### -Path @@ -72,8 +84,9 @@ Accept wildcard characters: False ``` ### -Attribute -Hashtable with names and values to be set. +Hashtable with names and values to be set. If setting a custom field, you can use either the name or guid as the key. +To clear a value overwriting policy, set the value to $null. ```yaml Type: Hashtable @@ -155,7 +168,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Set-TppCodeSignProjectStatus.md b/docs/functions/Set-TppCodeSignProjectStatus.md index 48659db2..de71e430 100644 --- a/docs/functions/Set-TppCodeSignProjectStatus.md +++ b/docs/functions/Set-TppCodeSignProjectStatus.md @@ -59,7 +59,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Set-TppCredential.md b/docs/functions/Set-TppCredential.md index 4eb78639..d5231bd5 100644 --- a/docs/functions/Set-TppCredential.md +++ b/docs/functions/Set-TppCredential.md @@ -59,7 +59,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Set-TppPermission.md b/docs/functions/Set-TppPermission.md index 593c8081..a04d5397 100644 --- a/docs/functions/Set-TppPermission.md +++ b/docs/functions/Set-TppPermission.md @@ -129,7 +129,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Set-TppWorkflowTicketStatus.md b/docs/functions/Set-TppWorkflowTicketStatus.md index 47a72537..7d8b3c29 100644 --- a/docs/functions/Set-TppWorkflowTicketStatus.md +++ b/docs/functions/Set-TppWorkflowTicketStatus.md @@ -112,7 +112,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Test-TppIdentity.md b/docs/functions/Test-TppIdentity.md index 0ed3ea86..50666c2b 100644 --- a/docs/functions/Test-TppIdentity.md +++ b/docs/functions/Test-TppIdentity.md @@ -65,7 +65,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Test-TppObject.md b/docs/functions/Test-TppObject.md index dddb10e1..ecd1693f 100644 --- a/docs/functions/Test-TppObject.md +++ b/docs/functions/Test-TppObject.md @@ -93,7 +93,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject diff --git a/docs/functions/Write-TppLog.md b/docs/functions/Write-TppLog.md index 762cf0ba..349e6d55 100644 --- a/docs/functions/Write-TppLog.md +++ b/docs/functions/Write-TppLog.md @@ -226,7 +226,7 @@ Accept wildcard characters: False Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TPP token or VaaS key can also provided. -If providing a TPP token, an environment variable named TppServer must also be set. +If providing a TPP token, an environment variable named TPP_SERVER must also be set. ```yaml Type: PSObject