Publish-BCFileContent
Publish-BCFileContent
Generates hashes, also called content information, for files in shared folders on a file server that have BranchCache enabled and the BranchCache for Network Files role service installed.
Syntax
Parameter Set: Publish_BCFileHashes12
Publish-BCFileContent [-Path] <String> [-AsJob] [-CimSession <CimSession> ] [-Force] [-Recurse] [-ReferenceFile <String> ] [-StageData] [-StagingPath <String> ] [-ThrottleLimit <Int32> ] [-UseVersion <UInt32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Publish-BCFileContent cmdlet generates hashes, also called content information, for files in shared folders on file servers that have BranchCache enabled and the BranchCache for Network Files role service installed.
This cmdlet is also used to stage data for the creation of a data preloading package. Run this cmdlet with the StageData parameter on one or more collections of files, then call the Export-BCCachePackage cmdlet to produce a data package containing all the staged data. This data package can be imported on remote hosted cache computers.
Parameters
-AsJob
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Force
Runs the cmdlet without prompting for confirmation.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Path<String>
Specifies the file path, or the path to a directory containing files, that will be hashed.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Recurse
Specifies that hashes are created for content in subfolders. If you do not use this parameter, then hashes are created only for content in the top folder and no hashes are created for content in subfolders.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ReferenceFile<String>
Specifies a reference file from a previous run. A reference file contains a list of identifiers that describe the data in a data package. If a reference file is supplied, all data described in that file will be excluded from the output of this cmdlet. Reference files can be used to create data packages that only contain the changes from the previous time a data package was created including the target data.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-StageData
Specifies that the data should be saved to a staging area for future export using the Export-BCCachePackage cmdlet. Use this parameter if a data package for export is being created. If this parameter in not specified, then hashes are generated for data, but the data is not prepared for export.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-StagingPath<String>
Specifies a temporary folder to which to output the staging data. If a location is not specified, then a default location on the local hard drive is used. Use this parameter if a large data package is being created that must be housed on a separate hard drive.
Aliases |
none |
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.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-UseVersion<UInt32>
Specifies the version of the BranchCache hashing scheme to use. If version specified is 1
, then content information is generated according to the scheme used by clients. If version specified is 2
, then content information is generated according to the more efficient hashing scheme used by client computers that are running operating systems later than Windows® 7.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
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, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- None
Outputs
The output type is the type of the objects that the cmdlet emits.
- None
Examples
EXAMPLE 1
This example hashes the contents of D:\share and adds the data to a cache package, that can later be exported and sent to a remote hosted cache server.
PS C:\> Publish-BCFileContent -Path D:\share -StageData