Import-BCSecret Key

Module:
branchcache
Imports the cryptographic key that BranchCache uses for the generation of segment secrets.

Syntax 

Import-BCSecretKey
      [-Filename] <String>
      -FilePassphrase <String>
      [-Force]
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-WhatIf]
      [-Confirm]
      [<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.

Examples

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.

Required Parameters

-FilePassphrase

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

Type: String
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Filename

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

Type: String
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Optional Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet.

For more information about Windows PowerShell background jobs, see about_Jobs .

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-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.

Type: CimSession[]
Aliases: Session
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Aliases: cf
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-Force

Forces the command to run without asking for user confirmation.

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ThrottleLimit

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.

Type: Int32
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf

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

Type: SwitchParameter
Aliases: wi
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Inputs

None

Outputs

None