< Back

Export-BCSecretKey

Tue Jan 29, 2019 10:13 pm

NAME Export-BCSecretKey



SYNOPSIS

Exports a secret key to a file.





SYNTAX

Export-BCSecretKey [-Filename] <String> [-FilePassphrase] <String> [-CimSession <CimSession[]>] [-Force] [-ThrottleLimit <Int32>] [-Confirm]

[-WhatIf] [<CommonParameters>]





DESCRIPTION

The Export-BCSecretKey cmdlet exports a secret key to a file.





PARAMETERS

-CimSession [<CimSession[]>]

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession

or Get-CimSession cmdlet. The default is the current session on the local computer.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-FilePassphrase <String>

Specifies the passphrase for the file that contains the key information to be affected by this cmdlet.



Required? true

Position? 3

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-Filename <String>

Specifies the path of the file to be affected by this cmdlet.



Required? true

Position? 2

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-Force [<SwitchParameter>]

Forces the command to run without asking for user confirmation.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-ThrottleLimit [<Int32>]

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0

is entered, then Windows PowerShell???? calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running

on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.



Required? false

Position? named

Default value none

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.



Required? false

Position? named

Default value false

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.



Required? false

Position? named

Default value false

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

None







OUTPUTS

None







Example 1: Export the secret key



PS C:\\>Export-BCSecretKey -Filename "C:\\share1\\secretkey.key" -FilePassphrase "mySecretPhrase"



This command exports the secret key to the file C:\\share1\\secretkey.key with the passphrase mySecretPhrase.







RELATED LINKS

Import-BCSecretKey

Set-BCSecretKey