< Back
Import-BCSecretKey
Post
NAME Import-BCSecretKey
SYNOPSIS
Imports the cryptographic key that BranchCache uses for the generation of segment secrets.
SYNTAX
Import-BCSecretKey [-Filename] <String> [-CimSession <CimSession[]>] [-Force] [-ThrottleLimit <Int32>] -FilePassphrase <String> [-Confirm]
[-WhatIf] [<CommonParameters>]
DESCRIPTION
The Import-BCSecretKey cmdlet imports the cryptographic key that BranchCache uses for the generation of segment secrets. Use this cmdlet when you
deploy BranchCache enabled content servers in a cluster or behind a network load balancer. If a file or webpage exists on multiple content
servers, each server must use the same secret key. Otherwise, each copy of the file will be cached separately in the branch office.
Use the Export-BCSecretKey cmdlet to export the secret key from one server to a file. Import the contents of this file by using this cmdlet.
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? named
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: Import a secret key
PS C:\\>Import-BCSecretKey -Filename "C:\\share1\\secretkey.key" -FilePassphrase "mySecretPhrase"
This command imports the key material in the file C:\\share1\\secretkey.key that is encrypted with the passphrase mySecretPhrase.
RELATED LINKS
Export-BCSecretKey
Set-BCSecretKey
SYNOPSIS
Imports the cryptographic key that BranchCache uses for the generation of segment secrets.
SYNTAX
Import-BCSecretKey [-Filename] <String> [-CimSession <CimSession[]>] [-Force] [-ThrottleLimit <Int32>] -FilePassphrase <String> [-Confirm]
[-WhatIf] [<CommonParameters>]
DESCRIPTION
The Import-BCSecretKey cmdlet imports the cryptographic key that BranchCache uses for the generation of segment secrets. Use this cmdlet when you
deploy BranchCache enabled content servers in a cluster or behind a network load balancer. If a file or webpage exists on multiple content
servers, each server must use the same secret key. Otherwise, each copy of the file will be cached separately in the branch office.
Use the Export-BCSecretKey cmdlet to export the secret key from one server to a file. Import the contents of this file by using this cmdlet.
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? named
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: Import a secret key
PS C:\\>Import-BCSecretKey -Filename "C:\\share1\\secretkey.key" -FilePassphrase "mySecretPhrase"
This command imports the key material in the file C:\\share1\\secretkey.key that is encrypted with the passphrase mySecretPhrase.
RELATED LINKS
Export-BCSecretKey
Set-BCSecretKey