Update manifest and docs to 5.8.0

Venafi · Jul 27, 2023 · 2bc1d2d · 2bc1d2d
1 parent a465b90
commit 2bc1d2d
Show file tree

Hide file tree

Showing 13 changed files with 1,390 additions and 23 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,13 @@
+## 5.8.0
+- Add `Find-VaasMachine` to find machines by type or status.  The list of attributes to search by will increase over time.  `Find-VaasObject -Type Machine` can always be used as well.
+- Add `Get-VaasMachine` to get machines by uuid, name, or get all.
+- Update `Invoke-VaasWorkflow` output to include workflow id (wsClientId)
+- Add machine creation functions `New-VaasMachine`, `New-VaasMachineIis`, and `New-VaasMachineCommonKeystore`.  These require PowerShell v7+ and have parallel processing.  `New-VaasMachine` is for basic machines with hostname, credential, and optional port, eg. Citrix and F5.
+- Add machine types to $VenafiSession.MachineTypes when using `New-VenafiSession` for VaaS
+- Add `Invoke-VenafiParallel` private function to easily execute operations in parallel.  Requires PowerShell v7+.
+- Add argument completer to `New-VaasMachine -MachineType` and `Find-VaasMachine -MachineType` for dynamic tab-ahead list of machine types
+- Add [PSSodium](https://github.com/TylerLeonhardt/PSSodium) as a nested module, required for machine creation functions
+
 ## 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
@@ -551,5 +561,6 @@
 
 
 
+
 
 
diff --git a/VenafiPS/VenafiPS.psd1 b/VenafiPS/VenafiPS.psd1
@@ -3,7 +3,7 @@
 #
 # Generated by: Venafi
 #
-# Generated on: 07/15/2023
+# Generated on: 07/27/2023
 #
 
 @{
@@ -12,7 +12,7 @@
 RootModule = 'VenafiPS.psm1'
 
 # Version number of this module.
-ModuleVersion = '5.8'
+ModuleVersion = '5.8.0'
 
 # Supported PSEditions
 # CompatiblePSEditions = @()
@@ -108,7 +108,9 @@ FunctionsToExport = 'Add-TppCertificateAssociation', 'Convert-TppObject',
                'Add-TppAdaptableHash', 'New-VaasCertificate', 'Find-VaasObject',
                'Remove-TppObject', 'Set-VaasTeam', 'Remove-VaasObject',
                'Invoke-VaasWorkflow', 'Get-VaasSatellite',
-               'Set-VaasCertificateAssignment', 'New-VaasMachineCommonKeystore', 'New-VaasMachineIis', 'New-VaasMachine', 'Get-VaasMachine', 'Find-VaasMachine'
+               'Set-VaasCertificateAssignment', 'New-VaasMachineCommonKeystore',
+               'New-VaasMachineIis', 'New-VaasMachine', 'Get-VaasMachine',
+               'Find-VaasMachine'
 
 # 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,13 @@
+## 5.8.0
+- Add `Find-VaasMachine` to find machines by type or status.  The list of attributes to search by will increase over time.  `Find-VaasObject -Type Machine` can always be used as well.
+- Add `Get-VaasMachine` to get machines by uuid, name, or get all.
+- Update `Invoke-VaasWorkflow` output to include workflow id (wsClientId)
+- Add machine creation functions `New-VaasMachine`, `New-VaasMachineIis`, and `New-VaasMachineCommonKeystore`.  These require PowerShell v7+ and have parallel processing.  `New-VaasMachine` is for basic machines with hostname, credential, and optional port, eg. Citrix and F5.
+- Add machine types to $VenafiSession.MachineTypes when using `New-VenafiSession` for VaaS
+- Add `Invoke-VenafiParallel` private function to easily execute operations in parallel.  Requires PowerShell v7+.
+- Add argument completer to `New-VaasMachine -MachineType` and `Find-VaasMachine -MachineType` for dynamic tab-ahead list of machine types
+- Add [PSSodium](https://github.com/TylerLeonhardt/PSSodium) as a nested module, required for machine creation functions
+
 ## 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
@@ -551,5 +561,6 @@
 
 
 
+
 
 
diff --git a/docs/functions/Find-VaasMachine.md b/docs/functions/Find-VaasMachine.md
@@ -0,0 +1,93 @@
+# Find-VaasMachine
+
+## SYNOPSIS
+Find machine info
+
+## SYNTAX
+
+```
+Find-VaasMachine [[-MachineType] <String>] [[-Status] <String>] [[-VenafiSession] <PSObject>]
+ [<CommonParameters>]
+```
+
+## DESCRIPTION
+Find machine info based on type and/or status.
+Multiple filters will be additive.
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+Find-VaasMachine -MachineType 'Citrix ADC'
+```
+
+Get machines of a specific type
+
+### EXAMPLE 2
+```
+Find-VaasMachine -Status 'VERIFIED'
+```
+
+Get machines with a specific status
+
+## PARAMETERS
+
+### -MachineType
+Machine type to retrieve. 
+Use tab-ahead for complete list.
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 1
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Status
+Status of machine, either 'DRAFT', 'VERIFIED', or 'UNVERIFIED'
+
+```yaml
+Type: String
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: 2
+Default value: None
+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: 3
+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
+
+## OUTPUTS
+
+### PSCustomObject
+## NOTES
+
+## RELATED LINKS
diff --git a/docs/functions/Get-VaasMachine.md b/docs/functions/Get-VaasMachine.md
@@ -0,0 +1,166 @@
+# Get-VaasMachine
+
+## SYNOPSIS
+Get machine info
+
+## SYNTAX
+
+### ID (Default)
+```
+Get-VaasMachine -ID <String> [-VenafiSession <PSObject>] [<CommonParameters>]
+```
+
+### All
+```
+Get-VaasMachine [-All] [-IncludeConnectionDetail] [-VenafiSession <PSObject>] [<CommonParameters>]
+```
+
+## DESCRIPTION
+Get info for either a specific machine or all.
+
+## EXAMPLES
+
+### EXAMPLE 1
+```
+Get-VaasMachine -ID 'c1'
+```
+
+companyId         : 0bc771e1-7abe-4339-9fcd-93fffe9cba7f
+name              : c1
+machineType       : Citrix ADC
+pluginId          : ff645e14-bd1a-11ed-a009-ce063932f86d
+integrationId     : d68a571d-24df-11ee-a0ae-f24d11bc4208
+edgeInstanceId    : 79fe96d0-0b93-11ee-8894-cb74b07067e5
+creationDate      : 7/17/2023 4:23:49 PM
+modificationDate  : 7/17/2023 4:32:48 PM
+status            : VERIFIED
+owningTeamId      : 59920180-a3e2-11ec-8dcd-3fcbf84c7da7
+connectionDetails : @{credentialType=local; hostnameOrAddress=1.2.3.4; password=RpSYhMjqxRr1QPROGqH4bKa1b3AQoik=;
+                    username=7sEvTe9CAEmXB/tKwF3NLCMFFWCv3+}
+machineId         : d68c7420-24df-11ee-9c2f-49251618e0a7
+
+Get info for a specific machine by name
+
+### EXAMPLE 2
+```
+Get-VaasMachine -ID 'ca7ff555-88d2-4bfc-9efa-2630ac44c1f2'
+```
+
+Get info for a specific machine by ID
+
+### EXAMPLE 3
+```
+Get-VaasMachine -All
+```
+
+companyId        : 0bc771e1-7abe-4339-9fcd-93fffe9cba7f
+name             : c1
+machineType      : Citrix ADC
+pluginId         : ff645e14-bd1a-11ed-a009-ce063932f86d
+integrationId    : d68a571d-24df-11ee-a0ae-f24d11bc4208
+edgeInstanceId   : 79fe96d0-0b93-11ee-8894-cb74b07067e5
+creationDate     : 7/17/2023 4:23:49 PM
+modificationDate : 7/17/2023 4:32:48 PM
+status           : VERIFIED
+owningTeamId     : 59920180-a3e2-11ec-8dcd-3fcbf84c7da7
+machineId        : d68c7420-24df-11ee-9c2f-49251618e0a7
+
+Get info for all machines
+
+### EXAMPLE 4
+```
+Get-VaasMachine -All -IncludeConnectionDetail
+```
+
+companyId         : 0bc771e1-7abe-4339-9fcd-93fffe9cba7f
+name              : c1
+machineType       : Citrix ADC
+pluginId          : ff645e14-bd1a-11ed-a009-ce063932f86d
+integrationId     : d68a571d-24df-11ee-a0ae-f24d11bc4208
+edgeInstanceId    : 79fe96d0-0b93-11ee-8894-cb74b07067e5
+creationDate      : 7/17/2023 4:23:49 PM
+modificationDate  : 7/17/2023 4:32:48 PM
+status            : VERIFIED
+owningTeamId      : 59920180-a3e2-11ec-8dcd-3fcbf84c7da7
+connectionDetails : @{credentialType=local; hostnameOrAddress=1.2.3.4; password=RpSYhMjqxRr1QPROGqH4bKa1b3AQoik=;
+                    username=7sEvTe9CAEmXB/tKwF3NLCMFFWCv3+}
+machineId         : d68c7420-24df-11ee-9c2f-49251618e0a7
+
+Get info for all machines including connection details
+
+## PARAMETERS
+
+### -ID
+Name or uuid to get info for a specific machine
+
+```yaml
+Type: String
+Parameter Sets: ID
+Aliases: machineId
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: True (ByPropertyName, ByValue)
+Accept wildcard characters: False
+```
+
+### -All
+Get all machines
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: All
+Aliases:
+
+Required: True
+Position: Named
+Default value: False
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -IncludeConnectionDetail
+{{ Fill IncludeConnectionDetail Description }}
+
+```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
diff --git a/docs/functions/Get-VaasSatellite.md b/docs/functions/Get-VaasSatellite.md
@@ -99,7 +99,7 @@ Name or uuid to get info for a specific VSatellite
 ```yaml
 Type: String
 Parameter Sets: ID
-Aliases: applicationId
+Aliases: vsatelliteId
 
 Required: True
 Position: Named

diff --git a/docs/functions/Import-TppCertificate.md b/docs/functions/Import-TppCertificate.md
@@ -243,7 +243,7 @@ Accept wildcard characters: False
 ### -VenafiSession
 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.
+A TPP token can also provided.
 If providing a TPP token, an environment variable named TPP_SERVER must also be set.
 
 ```yaml