Skip to content

Export-VdcVaultObject

SYNOPSIS

Export an object from the vault

SYNTAX

ToPipeline (Default)

Export-VdcVaultObject -ID <PSObject> [-VenafiSession <PSObject>] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

ToFile

Export-VdcVaultObject -ID <PSObject> -OutPath <String> [-VenafiSession <PSObject>]
 [-ProgressAction <ActionPreference>] [<CommonParameters>]

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

Get vault object details

EXAMPLE 2

Find-VdcObject -Path '\VED\Intermediate and Root Certificates\Trusted Root Certification Authorities' | Get-VdcAttribute -Attribute 'Certificate Vault Id' | Export-VdcVaultObject

Get intermediate or root certificates. Export to the pipeline instead of to a file.

EXAMPLE 3

Get-VdcCertificate -Path 'certificates\www.greg.com' -IncludePreviousVersions | Export-VdcVaultObject

Export historical certificates

EXAMPLE 4

Export-VdcVaultObject -ID 12345 -OutPath 'c:\temp'

Get vault object and save to a file

PARAMETERS

-ID

ID of the vault object to export

Type: PSObject
Parameter Sets: (All)
Aliases: VaultId, Certificate Vault Id, PreviousVersions

Required: True
Position: Named
Default value: None
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. If not provided, details will be provided to the pipeline.

Type: String
Parameter Sets: ToFile
Aliases:

Required: True
Position: Named
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.

Type: PSObject
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

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.

INPUTS

ID

OUTPUTS

PSCustomObject

NOTES