Update manifest and docs to 5.7.0

Venafi · Jul 15, 2023 · 15cf4ec · 15cf4ec
1 parent 6b60fc1
commit 15cf4ec
Show file tree

Hide file tree

Showing 7 changed files with 362 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,11 @@
+## 5.7.0
+- Add `Find-VenafiCertificate -SavedSearchName` to find VaaS certificate details via an existing saved search filter
+- Add `Get-VaasSatellite` to retrieve vsatellite details optionally including encryption key and algorithm
+- Add `Set-VaasCertificateAssignment` to add or replace applications associated to certificates
+- Add User property to `$VenafiSession` when connecting to VaaS.  All kinds of helpful info here including company ID.
+- Fix credentials not being written to the vault with `New-VenafiSession -VaultVaasKeyName`
+
+
 ## 5.6.0
 - Add specific error messages when a TPP token scope/privilege is not sufficient for the current function.  The message will include both the current and missing scope/privilege, [#175](https://github.com/Venafi/VenafiPS/issues/175).
 - Add `Set-VaasTeam` to update existing VaaS teams. You can update the name, role, and/or user matching rules. User matching rules can be overwritten or appended to.
@@ -542,5 +550,6 @@
 
 
 
+
 
 
diff --git a/VenafiPS/VenafiPS.psd1 b/VenafiPS/VenafiPS.psd1
@@ -3,7 +3,7 @@
 #
 # Generated by: Venafi
 #
-# Generated on: 07/12/2023
+# Generated on: 07/15/2023
 #
 
 @{
@@ -12,7 +12,7 @@
 RootModule = 'VenafiPS.psm1'
 
 # Version number of this module.
-ModuleVersion = '5.7'
+ModuleVersion = '5.7.0'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()
@@ -107,7 +107,8 @@ FunctionsToExport = 'Add-TppCertificateAssociation', 'Convert-TppObject',
                'Remove-TppEngineFolder', 'Add-TppEngineFolder', 'Revoke-TppGrant',
                'Add-TppAdaptableHash', 'New-VaasCertificate', 'Find-VaasObject',
                'Remove-TppObject', 'Set-VaasTeam', 'Remove-VaasObject',
-               'Invoke-VaasWorkflow', 'Get-VaasSatellite', 'Set-VaasCertificateAssignment'
+               'Invoke-VaasWorkflow', 'Get-VaasSatellite',
+               'Set-VaasCertificateAssignment'
 
 # 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,11 @@
+## 5.7.0
+- Add `Find-VenafiCertificate -SavedSearchName` to find VaaS certificate details via an existing saved search filter
+- Add `Get-VaasSatellite` to retrieve vsatellite details optionally including encryption key and algorithm
+- Add `Set-VaasCertificateAssignment` to add or replace applications associated to certificates
+- Add User property to `$VenafiSession` when connecting to VaaS.  All kinds of helpful info here including company ID.
+- Fix credentials not being written to the vault with `New-VenafiSession -VaultVaasKeyName`
+
+
 ## 5.6.0
 - Add specific error messages when a TPP token scope/privilege is not sufficient for the current function.  The message will include both the current and missing scope/privilege, [#175](https://github.com/Venafi/VenafiPS/issues/175).
 - Add `Set-VaasTeam` to update existing VaaS teams. You can update the name, role, and/or user matching rules. User matching rules can be overwritten or appended to.
@@ -542,5 +550,6 @@
 
 
 
+
 
 
diff --git a/docs/functions/Find-VenafiCertificate.md b/docs/functions/Find-VenafiCertificate.md
@@ -33,6 +33,12 @@ Find-VenafiCertificate [-Filter <ArrayList>] [-Order <PSObject[]>] [-IncludeVaas
  [-VenafiSession <PSObject>] [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]
 ```
 
+### VaasSavedSearch
+```
+Find-VenafiCertificate -SavedSearchName <String> [-IncludeVaasOwner] [-VenafiSession <PSObject>]
+ [-IncludeTotalCount] [-Skip <UInt64>] [-First <UInt64>] [<CommonParameters>]
+```
+
 ## DESCRIPTION
 Find certificates based on various attributes.
 Supports standard PS paging parameters First, Skip, and IncludeTotalCount.
@@ -890,13 +896,28 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -SavedSearchName
+{{ Fill SavedSearchName Description }}
+
+```yaml
+Type: String
+Parameter Sets: VaasSavedSearch
+Aliases:
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -IncludeVaasOwner
 Retrieve detailed user/team owner info, only for VaaS.
 This will cause additional api calls to be made and take longer.
 
 ```yaml
 Type: SwitchParameter
-Parameter Sets: VaaS
+Parameter Sets: VaaS, VaasSavedSearch
 Aliases:
 
 Required: False

diff --git a/docs/functions/Get-VaasSatellite.md b/docs/functions/Get-VaasSatellite.md
@@ -0,0 +1,178 @@
+# Get-VaasSatellite
+
+## SYNOPSIS
+Get VSatellite info
+
+## SYNTAX
+
+### ID (Default)
+```
+Get-VaasSatellite -ID <String> [-IncludeKey] [-VenafiSession <PSObject>] [<CommonParameters>]
+```
+
+### All
+```
+Get-VaasSatellite [-All] [-IncludeKey] [-VenafiSession <PSObject>] [<CommonParameters>]
+```
+
+## DESCRIPTION
+Get info for either a specific VSatellite or all.
+There is an option to also include the encryption key and algorithm.
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+Get-VaasSatellite -ID 'VSatellite Hub 0001'
+```
+
+companyId                   : a05013bd-921d-440c-bc22-c9ead5c8d548
+productEntitlements         : {ANY}
+environmentId               : a05013bd-921d-440c-bc22-c9ead5c8d548
+pairingCodeId               : a05013bd-921d-440c-bc22-c9ead5c8d548
+name                        : VSatellite Hub 0001
+edgeType                    : HUB
+edgeStatus                  : ACTIVE
+clientId                    : a05013bd-921d-440c-bc22-c9ead5c8d548
+modificationDate            : 6/15/2023 11:48:40 AM
+address                     : 1.2.3.4
+deploymentDate              : 6/15/2023 11:44:14 AM
+lastSeenOnDate              : 7/13/2023 12:00:40 PM
+reconciliationFailed        : False
+encryptionKeyId             : mwU4oTet9KwTGggRfhek0UtvighIw=
+encryptionKeyDeploymentDate : 6/15/2023 11:48:40 AM
+kubernetesVersion           : v1.23.6+k3s1
+integrationServicesCount    : 0
+vsatelliteId                : a05013bd-921d-440c-bc22-c9ead5c8d548
+encryptionKey               :
+encryptionKeyAlgorithm      :
+
+Get info for a specific VSatellite by name
+
+### EXAMPLE 2
+```
+Get-VaasSatellite -ID 'ca7ff555-88d2-4bfc-9efa-2630ac44c1f2'
+```
+
+Get info for a specific VSatellite
+
+### EXAMPLE 3
+```
+Get-VaasSatellite -All
+```
+
+Get info for all VSatellites
+
+### EXAMPLE 4
+```
+Get-VaasSatellite -All -IncludeKey
+```
+
+companyId                   : a05013bd-921d-440c-bc22-c9ead5c8d548
+productEntitlements         : {ANY}
+environmentId               : a05013bd-921d-440c-bc22-c9ead5c8d548
+pairingCodeId               : a05013bd-921d-440c-bc22-c9ead5c8d548
+name                        : VSatellite Hub 0001
+edgeType                    : HUB
+edgeStatus                  : ACTIVE
+clientId                    : a05013bd-921d-440c-bc22-c9ead5c8d548
+modificationDate            : 6/15/2023 11:48:40 AM
+address                     : 1.2.3.4
+deploymentDate              : 6/15/2023 11:44:14 AM
+lastSeenOnDate              : 7/13/2023 12:00:40 PM
+reconciliationFailed        : False
+encryptionKeyId             : mwU4oTet9KwTGggRfhek0UtvighIw=
+encryptionKeyDeploymentDate : 6/15/2023 11:48:40 AM
+kubernetesVersion           : v1.23.6+k3s1
+integrationServicesCount    : 0
+vsatelliteId                : a05013bd-921d-440c-bc22-c9ead5c8d548
+encryptionKey               : o4aFaJUTtCydprvgRupQ1ZiY=
+encryptionKeyAlgorithm      : ED25519
+
+Get info for VSatellites including the encryption key and algorithm
+
+## PARAMETERS
+
+### -ID
+Name or uuid to get info for a specific VSatellite
+
+```yaml
+Type: String
+Parameter Sets: ID
+Aliases: applicationId
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName, ByValue)
+Accept wildcard characters: False
+```
+
+### -All
+Get all VSatellites
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: All
+Aliases:
+
+Required: True
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -IncludeKey
+Include the encryption key and algorithm
+
+```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 VaaS key can also provided.
+
+```yaml
+Type: PSObject
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: $script:VenafiSession
+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
+
+### ID
+## OUTPUTS
+
+### PSCustomObject
+## NOTES
+
+## RELATED LINKS
+
+[http://VenafiPS.readthedocs.io/en/latest/functions/Get-VaasSatellite/](http://VenafiPS.readthedocs.io/en/latest/functions/Get-VaasSatellite/)
+
+[https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/Get-VaasSatellite.ps1](https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/Get-VaasSatellite.ps1)
+
+[https://developer.venafi.com/tlsprotectcloud/reference/edgeinstances_getall](https://developer.venafi.com/tlsprotectcloud/reference/edgeinstances_getall)
+
+[https://developer.venafi.com/tlsprotectcloud/reference/edgeencryptionkeys_getall](https://developer.venafi.com/tlsprotectcloud/reference/edgeencryptionkeys_getall)
+