From 417259d060e39df6ad5e9aafebe4f411cec659a4 Mon Sep 17 00:00:00 2001 From: Greg Brownstein Date: Mon, 8 Jul 2024 22:23:15 +0000 Subject: [PATCH] Update manifest and docs to 6.4.0 --- CHANGELOG.md | 8 ++ VenafiPS/VenafiPS.psd1 | 4 +- docs/changelog.md | 8 ++ docs/functions/Export-VdcCertificate.md | 2 +- docs/functions/Export-VdcVaultObject.md | 104 ++++++++++++++++++++++++ docs/functions/Get-VcCertificate.md | 4 +- docs/functions/Get-VdcCertificate.md | 8 +- docs/functions/New-VcConnector.md | 58 +++++++++++-- mkdocs.yml | 1 + 9 files changed, 182 insertions(+), 15 deletions(-) create mode 100644 docs/functions/Export-VdcVaultObject.md diff --git a/CHANGELOG.md b/CHANGELOG.md index f1aaea56..d043c375 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,10 @@ +## 6.4.0 +- Add `Export-VdcVaultObject` to retrieve historical certificates. This function supports certificates, keys, and p12. [#280](https://github.com/Venafi/VenafiPS/issues/280) +- Add support in `New-VcConnector` for manifests from the simulator and 'full' ones which already have deployment details +- Fix `Add-VcCertificateAssociation` when piping certificate objects, [#284](https://github.com/Venafi/VenafiPS/issues/284) +- Fix examples in `Get-VcCertificate` and `Get-VdcCertificate` referencing old parameter names, [#279](https://github.com/Venafi/VenafiPS/issues/279) + + ## 6.3.2 - Add `Get-VdcCredential -IncludeDetail` to provide additional credential information eg. expiration, path to linked certificate, and more - Add discrete parameters to `Set-VdcCredential` to simplify updating credentials; `-Value` will be deprecated. Add support for updating the Expiration and setting a Credential 'link' to an existing certificate in TLSPDC. @@ -700,5 +707,6 @@ This is a major release. Although every attempt has been made to be backwards c + diff --git a/VenafiPS/VenafiPS.psd1 b/VenafiPS/VenafiPS.psd1 index e39c8da1..d1472853 100644 --- a/VenafiPS/VenafiPS.psd1 +++ b/VenafiPS/VenafiPS.psd1 @@ -3,7 +3,7 @@ # # Generated by: Greg Brownstein # -# Generated on: 05/14/2024 +# Generated on: 07/08/2024 # @{ @@ -12,7 +12,7 @@ RootModule = 'VenafiPS.psm1' # Version number of this module. -ModuleVersion = '6.4' +ModuleVersion = '6.4.0' # Supported PSEditions # CompatiblePSEditions = @() diff --git a/docs/changelog.md b/docs/changelog.md index c7b565da..b3b5890f 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -1,3 +1,10 @@ +## 6.4.0 +- Add `Export-VdcVaultObject` to retrieve historical certificates. This function supports certificates, keys, and p12. [#280](https://github.com/Venafi/VenafiPS/issues/280) +- Add support in `New-VcConnector` for manifests from the simulator and 'full' ones which already have deployment details +- Fix `Add-VcCertificateAssociation` when piping certificate objects, [#284](https://github.com/Venafi/VenafiPS/issues/284) +- Fix examples in `Get-VcCertificate` and `Get-VdcCertificate` referencing old parameter names, [#279](https://github.com/Venafi/VenafiPS/issues/279) + + ## 6.3.2 - Add `Get-VdcCredential -IncludeDetail` to provide additional credential information eg. expiration, path to linked certificate, and more - Add discrete parameters to `Set-VdcCredential` to simplify updating credentials; `-Value` will be deprecated. Add support for updating the Expiration and setting a Credential 'link' to an existing certificate in TLSPDC. @@ -700,5 +707,6 @@ This is a major release. Although every attempt has been made to be backwards c + diff --git a/docs/functions/Export-VdcCertificate.md b/docs/functions/Export-VdcCertificate.md index 45b2a973..5c9c02e8 100644 --- a/docs/functions/Export-VdcCertificate.md +++ b/docs/functions/Export-VdcCertificate.md @@ -1,7 +1,7 @@ # Export-VdcCertificate ## SYNOPSIS -Expoort certificate data from TLSPDC +Export certificate data from TLSPDC ## SYNTAX diff --git a/docs/functions/Export-VdcVaultObject.md b/docs/functions/Export-VdcVaultObject.md new file mode 100644 index 00000000..ed530b19 --- /dev/null +++ b/docs/functions/Export-VdcVaultObject.md @@ -0,0 +1,104 @@ +# Export-VdcVaultObject + +## SYNOPSIS +Export an object from the vault + +## SYNTAX + +``` +Export-VdcVaultObject [-ID] [-OutPath] [[-VenafiSession] ] + [-ProgressAction ] [] +``` + +## DESCRIPTION +Export different object types from the vault. +The currently supported types are certificate, key, and PKCS12. +If the type is not supported, the base64 data will be returned as is. + +## EXAMPLES + +### EXAMPLE 1 +``` +Export-VdcVaultObject -ID 12345 -OutPath 'c:\temp' +``` + +Get vault object and save to a file + +## PARAMETERS + +### -ID +ID of the vault object to export + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: VaultId + +Required: True +Position: 1 +Default value: 0 +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OutPath +Folder path to save the certificate/key to. +The name of the file will be determined automatically. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +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 TLSPDC token can also be provided. +If providing a TLSPDC token, an environment variable named VDC_SERVER must also be set. + +```yaml +Type: PSObject +Parameter Sets: (All) +Aliases: + +Required: False +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +Default value: None +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 if unhandled type, otherwise saves the object to a file +## NOTES + +## RELATED LINKS diff --git a/docs/functions/Get-VcCertificate.md b/docs/functions/Get-VcCertificate.md index cba4839b..80d015da 100644 --- a/docs/functions/Get-VcCertificate.md +++ b/docs/functions/Get-VcCertificate.md @@ -24,7 +24,7 @@ Get certificate information, either all available to the api key provided or by ### EXAMPLE 1 ``` -Get-VdcCertificate -CertificateId 'ca7ff555-88d2-4bfc-9efa-2630ac44c1f2' +Get-VdcCertificate -ID 'ca7ff555-88d2-4bfc-9efa-2630ac44c1f2' ``` Get certificate info for a specific cert @@ -120,7 +120,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### CertificateId +### ID ## OUTPUTS ### PSCustomObject diff --git a/docs/functions/Get-VdcCertificate.md b/docs/functions/Get-VdcCertificate.md index 00558fa3..c1ba2029 100644 --- a/docs/functions/Get-VdcCertificate.md +++ b/docs/functions/Get-VdcCertificate.md @@ -36,7 +36,7 @@ Get certificate information, either all available to the api key provided or by ### EXAMPLE 1 ``` -Get-VdcCertificate -CertificateId '\ved\policy\mycert.com' +Get-VdcCertificate -ID '\ved\policy\mycert.com' ``` Get certificate info for a specific cert @@ -50,14 +50,14 @@ Get certificate info for all certs ### EXAMPLE 3 ``` -Get-VdcCertificate -CertificateId '\ved\policy\mycert.com' -IncludePreviousVersions +Get-VdcCertificate -ID '\ved\policy\mycert.com' -IncludePreviousVersions ``` Get certificate info for a specific cert, including historical versions of the certificate. ### EXAMPLE 4 ``` -Get-VdcCertificate -CertificateId '\ved\policy\mycert.com' -IncludeTppPreviousVersions -ExcludeRevoked -ExcludeExpired +Get-VdcCertificate -ID '\ved\policy\mycert.com' -IncludeTppPreviousVersions -ExcludeRevoked -ExcludeExpired ``` Get certificate info for a specific cert, including historical versions of the certificate that are not revoked or expired. @@ -197,7 +197,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### CertificateId +### ID ## OUTPUTS ### PSCustomObject diff --git a/docs/functions/New-VcConnector.md b/docs/functions/New-VcConnector.md index 44fd21b3..98f1f652 100644 --- a/docs/functions/New-VcConnector.md +++ b/docs/functions/New-VcConnector.md @@ -5,11 +5,18 @@ Create a new connector ## SYNTAX +### FullManifest (Default) ``` -New-VcConnector [-ManifestPath] [-PassThru] [[-VenafiSession] ] +New-VcConnector -ManifestPath [-PassThru] [-VenafiSession ] [-ProgressAction ] [-WhatIf] [-Confirm] [] ``` +### FromSimulator +``` +New-VcConnector -ManifestPath -DeploymentImage [-Maintainer ] [-PassThru] + [-VenafiSession ] [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + ## DESCRIPTION Create a new machine, CA, TPP, or credential connector @@ -20,7 +27,7 @@ Create a new machine, CA, TPP, or credential connector New-VcConnector -ManifestPath '/tmp/manifest.json' ``` -Create a new connector +Create a new connector from a full manifest ### EXAMPLE 2 ``` @@ -29,12 +36,19 @@ New-VcConnector -ManifestPath '/tmp/manifest.json' -PassThru Create a new connector and return the newly created connector object +### EXAMPLE 3 +``` +New-VcConnector -ManifestPath '/tmp/manifest.json' -DeploymentImage 'docker.io/venafi/connector:latest@sha256:1234567890abcdef' +``` + +Create a new connector from a manifest from the simulator + ## PARAMETERS ### -ManifestPath Path to an existing manifest. -Ensure the manifest has the deployment element which is not needed when testing in the simulator. -See https://github.com/Venafi/vmware-avi-connector?tab=readme-ov-file#manifest for details. +Manifest can either be directly from the simulator or a full manifest with deployment element. +If the manifest is from the simulator, the DeploymentImage parameter is required. ```yaml Type: String @@ -42,7 +56,39 @@ Parameter Sets: (All) Aliases: Required: True -Position: 1 +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DeploymentImage +Path to the already uploaded docker image. +This parameter is only to be used for a manifest directly from the simulator. + +```yaml +Type: String +Parameter Sets: FromSimulator +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Maintainer +Optional value to specify the organization, individual, email, location, or website responsible for maintaining the connector +This parameter is only to be used for a manifest directly from the simulator. + +```yaml +Type: String +Parameter Sets: FromSimulator +Aliases: + +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -74,7 +120,7 @@ Parameter Sets: (All) Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/mkdocs.yml b/mkdocs.yml index f9b19a67..95d199a4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -40,6 +40,7 @@ nav: - ConvertTo-VdcPath: functions/ConvertTo-VdcPath.md - Export-VcCertificate: functions/Export-VcCertificate.md - Export-VdcCertificate: functions/Export-VdcCertificate.md + - Export-VdcVaultObject: functions/Export-VdcVaultObject.md - Find-VcCertificate: functions/Find-VcCertificate.md - Find-VcCertificateInstance: functions/Find-VcCertificateInstance.md - Find-VcCertificateRequest: functions/Find-VcCertificateRequest.md