MSFT_NetBranchCacheOrchestrator, ROOT\StandardCimv2\MS_409
Class
| Methods (29)
| Properties (4)
| Qualifiers (3)
| Instances | Namespaces (2)
Samples: VB Script
| C#
| VB.Net
| Search on:Microsoft
Description BranchCache task orchestrator
MSFT_NetBranchCacheOrchestrator methods MSFT_NetBranchCacheOrchestrator has 29 methods (29 Local )
MSFT_NetBranchCacheOrchestrator properties MSFT_NetBranchCacheOrchestrator has 4 properties (4 Derived )
Detailed description of MSFT_NetBranchCacheOrchestrator methods Local methods (29) of MSFT_NetBranchCacheOrchestrator class ▲ Add_BCDataCacheExtensionByPercentage methodReturn uint32 {'out':True} Parameters Name CIMType ID IN OUT Qualifiers Percentage uint32 0 ✓ - {'Description':'Specifies the new size (in terms of disk percentage) of this cache file.','In':True} Path string 1 ✓ - {'Description':'Specifies the cache file to operate on.','In':True} PassThru boolean 2 ✓ - {'Description':'Indicates the newly created cache extension should be output','In':True} Force boolean 3 ✓ - {'Description':'Indicates the operation should not prompt for confirmation','In':True} cmdletOutput object :MSFT_NetBranchCacheDataCacheExtension 4 - ✓ {'Out':True}
Description 'Adds a new republication cache file to increase the amount of storage available on a hosted cache server.' Add_BCDataCacheExtensionByPercentage method is in 1 class (MSFT_NetBranchCacheOrchestrator) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
▲ Add_BCDataCacheExtensionBySizeBytes methodReturn uint32 {'out':True} Parameters Name CIMType ID IN OUT Qualifiers SizeBytes uint64 0 ✓ - {'Description':'Specifies the new size of this cache file.','In':True} Path string 1 ✓ - {'Description':'Specifies the cache file to operate on.','In':True} PassThru boolean 2 ✓ - {'Description':'Indicates the newly created cache extension should be output','In':True} Force boolean 3 ✓ - {'Description':'Indicates the operation should not prompt for confirmation','In':True} cmdletOutput object :MSFT_NetBranchCacheDataCacheExtension 4 - ✓ {'Out':True}
Description 'Adds a new republication cache file to increase the amount of storage available on a hosted cache server.' Add_BCDataCacheExtensionBySizeBytes method is in 1 class (MSFT_NetBranchCacheOrchestrator) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
▲ Clear_BCCache methodReturn uint32 {'out':True} Parameters Name CIMType ID IN OUT Qualifiers Force boolean 0 ✓ - {'Description':'Indicates the operation should not prompt for confirmation','In':True}
Description 'Deletes all data in all cache files. ' Clear_BCCache method is in 1 class (MSFT_NetBranchCacheOrchestrator) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
▲ Disable_BC methodReturn uint32 {'out':True} Parameters Name CIMType ID IN OUT Qualifiers Force boolean 0 ✓ - {'Description':'Indicates the operation should not prompt for confirmation','In':True}
Description 'Disables the BranchCache service. ' Disable_BC method is in 1 class (MSFT_NetBranchCacheOrchestrator) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
▲ Disable_BCDowngrading methodReturn uint32 {'out':True} Parameters Name CIMType ID IN OUT Qualifiers Force boolean 0 ✓ - {'Description':'Indicates the operation should not prompt for confirmation','In':True}
Description 'Disables downgrading, so that the client will no longer request the specified version of content information from servers.' Disable_BCDowngrading method is in 1 class (MSFT_NetBranchCacheOrchestrator) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
▲ Disable_BCServeOnBattery methodReturn uint32 {'out':True} Parameters Name CIMType ID IN OUT Qualifiers Force boolean 0 ✓ - {'Description':'Indicates the operation should not prompt for confirmation','In':True}
Description 'A client may be configured to not listen for content discovery requests in distributed cache mode when operating on battery.' Disable_BCServeOnBattery method is in 1 class (MSFT_NetBranchCacheOrchestrator) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
▲ Enable_BCDistributed methodReturn uint32 {'out':True} Parameters Name CIMType ID IN OUT Qualifiers Force boolean 0 ✓ - {'Description':'Indicates the operation should not prompt for confirmation','In':True}
Description 'Enables BranchCache and configures a machine to operate in distributed cache mode.' Enable_BCDistributed method is in 1 class (MSFT_NetBranchCacheOrchestrator) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
▲ Enable_BCDowngrading methodReturn uint32 {'out':True} Parameters Name CIMType ID IN OUT Qualifiers Version uint32 0 ✓ - {'Description':'Specifies whether or not the client should operate in a downgraded mode and which version should be used.','In':True} Force boolean 1 ✓ - {'Description':'Indicates the operation should not prompt for confirmation','In':True}
Description 'Client may be instructed to operate in a downgraded mode, in which it will issue specified version requests to content servers.' Enable_BCDowngrading method is in 1 class (MSFT_NetBranchCacheOrchestrator) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
▲ Enable_BCHostedClientByServerNames methodReturn uint32 {'out':True} Parameters Name CIMType ID IN OUT Qualifiers ServerNames string 0 ✓ - {'Description':'Names of the hosted cache servers to use.','In':True} UseVersion uint32 1 ✓ - {'Description':'Version of the offer protocol to use when contacting this hosted cache server.','In':True} Force boolean 2 ✓ - {'Description':'Indicates the operation should not prompt for confirmation','In':True}
Description 'Configures BranchCache to operate in hosted cache client mode. ' Enable_BCHostedClientByServerNames method is in 1 class (MSFT_NetBranchCacheOrchestrator) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
▲ Enable_BCHostedClientByUseSCP methodReturn uint32 {'out':True} Parameters Name CIMType ID IN OUT Qualifiers UseSCP boolean 0 ✓ - {'Description':'Indicates the client should locate hosted cache servers using service connection points.','In':True} Force boolean 1 ✓ - {'Description':'Indicates the operation should not prompt for confirmation','In':True}
Description 'Configures BranchCache to operate in hosted cache client mode. ' Enable_BCHostedClientByUseSCP method is in 1 class (MSFT_NetBranchCacheOrchestrator) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
▲ Enable_BCHostedServer methodReturn uint32 {'out':True} Parameters Name CIMType ID IN OUT Qualifiers RegisterSCP boolean 0 ✓ - {'Description':'Indicates the hosted cache server should register a service connection point','In':True} Force boolean 1 ✓ - {'Description':'Indicates the operation should not prompt for confirmation','In':True}
Description 'Configures BranchCache to operate in hosted cache server mode. ' Enable_BCHostedServer method is in 1 class (MSFT_NetBranchCacheOrchestrator) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
▲ Enable_BCLocal methodReturn uint32 {'out':True} Parameters Name CIMType ID IN OUT Qualifiers Force boolean 0 ✓ - {'Description':'Indicates the operation should not prompt for confirmation','In':True}
Description 'Enables the BranchCache service in local caching mode.' Enable_BCLocal method is in 1 class (MSFT_NetBranchCacheOrchestrator) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
▲ Enable_BCServeOnBattery methodReturn uint32 {'out':True} Parameters Name CIMType ID IN OUT Qualifiers Force boolean 0 ✓ - {'Description':'Indicates the operation should not prompt for confirmation','In':True}
Description 'Configures a client to listen for content discovery requests in distributed cache mode when operating on battery.' Enable_BCServeOnBattery method is in 1 class (MSFT_NetBranchCacheOrchestrator) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
▲ Export_BCCachePackageByExportDataCache methodReturn uint32 {'out':True} Parameters Name CIMType ID IN OUT Qualifiers ExportDataCache boolean 0 ✓ - {'Description':'Indicates the contents of the local data cache will be included in the package','In':True} Destination string 1 ✓ - {'Description':'Specifies the path to the data package','In':True} Force boolean 2 ✓ - {'Description':'Indicates the operation should not prompt for confirmation','In':True}
Description 'Exports a cache package' Export_BCCachePackageByExportDataCache method is in 1 class (MSFT_NetBranchCacheOrchestrator) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
▲ Export_BCCachePackageByStagingPath methodReturn uint32 {'out':True} Parameters Name CIMType ID IN OUT Qualifiers StagingPath string 0 ✓ - {'Description':'Specifies the location of the cache files to be packaged','In':True} Destination string 1 ✓ - {'Description':'Specifies the path to the data package','In':True} OutputReferenceFile string 2 ✓ - {'Description':'Specifies the path where an output reference file should be generated','In':True} Force boolean 3 ✓ - {'Description':'Indicates the operation should not prompt for confirmation','In':True}
Description 'Exports a cache package' Export_BCCachePackageByStagingPath method is in 1 class (MSFT_NetBranchCacheOrchestrator) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
▲ Export_BCSecretKey methodReturn uint32 {'out':True} Parameters Name CIMType ID IN OUT Qualifiers Filename string 0 ✓ - {'Description':'Path of the file that will contain the key information.','In':True} FilePassphrase string 1 ✓ - {'Description':'Passphrase used to encrypt the file containing the key information.','In':True} Force boolean 2 ✓ - {'Description':'Indicates the operation should not prompt for confirmation','In':True}
Description 'Exports a secret key to a file.' Export_BCSecretKey method is in 1 class (MSFT_NetBranchCacheOrchestrator) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
▲ Import_BCCachePackage methodReturn uint32 {'out':True} Parameters Name CIMType ID IN OUT Qualifiers Path string 0 ✓ - {'Description':'Specifies the cache package to import','In':True} Force boolean 1 ✓ - {'Description':'Indicates the operation should not prompt for confirmation','In':True}
Description 'Imports a cache package' Import_BCCachePackage method is in 1 class (MSFT_NetBranchCacheOrchestrator) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
▲ Import_BCSecretKey methodReturn uint32 {'out':True} Parameters Name CIMType ID IN OUT Qualifiers Filename string 0 ✓ - {'Description':'Path of the file containing the key information to import.','In':True} FilePassphrase string 1 ✓ - {'Description':'Passphrase for the file containing the key information.','In':True} Force boolean 2 ✓ - {'Description':'Indicates the operation should not prompt for confirmation','In':True}
Description 'Imports the cryptographic key used in the generation of segment secrets.' Import_BCSecretKey method is in 1 class (MSFT_NetBranchCacheOrchestrator) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
▲ Publish_BCFileHashes methodReturn uint32 {'out':True} Parameters Name CIMType ID IN OUT Qualifiers Path string 0 ✓ - {'Description':'Specifies the file or folder to be hashed','In':True} UseVersion uint32 1 ✓ - {'Description':'Specifies the version of the BranchCache hashing scheme to use','In':True} StageData boolean 2 ✓ - {'Description':'Indicates the hashes should be saved to a staging area for future export','In':True} StagingPath string 3 ✓ - {'Description':'Specifies a temporary folder to output staging data to','In':True} ReferenceFile string 4 ✓ - {'Description':'Specifies a reference file from a previous execution','In':True} Recurse boolean 5 ✓ - {'Description':'Specifies the operation should be applied to subfolders','In':True} Force boolean 6 ✓ - {'Description':'Indicates the operation should not prompt for confirmation','In':True}
Description 'Creates hashes for file content' Publish_BCFileHashes method is in 1 class (MSFT_NetBranchCacheOrchestrator) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
▲ Publish_BCWebHashes methodReturn uint32 {'out':True} Parameters Name CIMType ID IN OUT Qualifiers Path string 0 ✓ - {'Description':'Specifies the file or folder to be hashed','In':True} UseVersion uint32 1 ✓ - {'Description':'Specifies the version of the BranchCache hashing scheme to use','In':True} StageData boolean 2 ✓ - {'Description':'Indicates the hashes should be saved to a staging area for future export','In':True} StagingPath string 3 ✓ - {'Description':'Specifies a temporary folder to output staging data to','In':True} ReferenceFile string 4 ✓ - {'Description':'Specifies a reference file from a previous execution','In':True} Recurse boolean 5 ✓ - {'Description':'Specifies the operation should be applied to subfolders','In':True} Force boolean 6 ✓ - {'Description':'Indicates the operation should not prompt for confirmation','In':True}
Description 'Creates hashes for web content' Publish_BCWebHashes method is in 1 class (MSFT_NetBranchCacheOrchestrator) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
▲ Remove_BCDataCacheExtensionByDataCacheExtension methodReturn uint32 {'out':True} Parameters Name CIMType ID IN OUT Qualifiers DataCacheExtension object :MSFT_NetBranchCacheDataCacheExtension 0 ✓ - {'Description':'The cache extension which should be removed','In':True} Force boolean 1 ✓ - {'Description':'Indicates the operation should not prompt for confirmation','In':True}
Description 'Deletes a cache file.' Remove_BCDataCacheExtensionByDataCacheExtension method is in 1 class (MSFT_NetBranchCacheOrchestrator) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
▲ Remove_BCDataCacheExtensionByPath methodReturn uint32 {'out':True} Parameters Name CIMType ID IN OUT Qualifiers Path string 0 ✓ - {'Description':'Specifies the cache file to operate on. ','In':True} Force boolean 1 ✓ - {'Description':'Indicates the operation should not prompt for confirmation','In':True}
Description 'Deletes a cache file.' Remove_BCDataCacheExtensionByPath method is in 1 class (MSFT_NetBranchCacheOrchestrator) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
▲ Reset_BC methodReturn uint32 {'out':True} Parameters Name CIMType ID IN OUT Qualifiers ResetFWRulesOnly boolean 0 ✓ - {'Description':'If True, resets only the Windows firewall rules.','In':True} ResetPerfCountersOnly boolean 1 ✓ - {'Description':'If True, resets only the Performance Counters.','In':True} Force boolean 2 ✓ - {'Description':'Indicates the operation should not prompt for confirmation','In':True}
Description 'Resets BranchCache to a default configuration.' Reset_BC method is in 1 class (MSFT_NetBranchCacheOrchestrator) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
▲ Set_BCAuthentication methodReturn uint32 {'out':True} Parameters Name CIMType ID IN OUT Qualifiers Mode uint32 0 ✓ - {'Description':'Specifies the authentication mode. ','In':True} Force boolean 1 ✓ - {'Description':'Indicates the operation should not prompt for confirmation','In':True}
Description 'Specifies the authentication scheme for clients.' Set_BCAuthentication method is in 1 class (MSFT_NetBranchCacheOrchestrator) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
▲ Set_BCCacheByCache methodReturn uint32 {'out':True} Parameters Name CIMType ID IN OUT Qualifiers Cache object :MSFT_NetBranchCacheCache 0 ✓ - {'Description':'The cache which should be modified','In':True} MoveTo string 1 ✓ - {'Description':'Specifies the new location on disk for this this cache file.','In':True} Percentage uint32 2 ✓ - {'Description':'Specifies the new size (in terms of disk percentage) of this cache file.','In':True} SizeBytes uint64 3 ✓ - {'Description':'Specifies the new size of this cache file.','In':True} Defragment boolean 4 ✓ - {'Description':'Indicates the cache should be defragmented','In':True} PassThru boolean 5 ✓ - {'Description':'Indicates the modified cache should be output','In':True} Force boolean 6 ✓ - {'Description':'Indicates the operation should not prompt for confirmation','In':True} cmdletOutput object :MSFT_NetBranchCacheCache 7 - ✓ {'Out':True}
Description 'Modifies the cache file configuration.' Set_BCCacheByCache method is in 1 class (MSFT_NetBranchCacheOrchestrator) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
▲ Set_BCCacheByPath methodReturn uint32 {'out':True} Parameters Name CIMType ID IN OUT Qualifiers Path string 0 ✓ - {'Description':'Specifies the cache file to operate on.','In':True} MoveTo string 1 ✓ - {'Description':'Specifies the new location on disk for this this cache file.','In':True} Percentage uint32 2 ✓ - {'Description':'Specifies the new size (in terms of disk percentage) of this cache file.','In':True} SizeBytes uint64 3 ✓ - {'Description':'Specifies the new size of this cache file.','In':True} Defragment boolean 4 ✓ - {'Description':'Indicates the cache should be defragmented','In':True} PassThru boolean 5 ✓ - {'Description':'Indicates the modified cache should be output','In':True} Force boolean 6 ✓ - {'Description':'Indicates the operation should not prompt for confirmation','In':True} cmdletOutput object :MSFT_NetBranchCacheCache 7 - ✓ {'Out':True}
Description 'Modifies the cache file configuration.' Set_BCCacheByPath method is in 1 class (MSFT_NetBranchCacheOrchestrator) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
▲ Set_BCDataCacheEntryMaxAge methodReturn uint32 {'out':True} Parameters Name CIMType ID IN OUT Qualifiers TimeDays uint32 0 ✓ - {'Description':'The maximum number of days a cache entry is valid in the data cache.','In':True} Force boolean 1 ✓ - {'Description':'Indicates the operation should not prompt for confirmation.','In':True}
Description 'Sets the maximum age of an entry in the data cache.' Set_BCDataCacheEntryMaxAge method is in 1 class (MSFT_NetBranchCacheOrchestrator) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
▲ Set_BCMinSMBLatency methodReturn uint32 {'out':True} Parameters Name CIMType ID IN OUT Qualifiers LatencyMilliseconds uint32 0 ✓ - {'Description':'Minimum latency that must exist between client and server before BranchCache should be used.','In':True} Force boolean 1 ✓ - {'Description':'Indicates the operation should not prompt for confirmation','In':True}
Description 'Sets the minimum latency that must exist between client and server before transparent caching functions are utilized.' Set_BCMinSMBLatency method is in 1 class (MSFT_NetBranchCacheOrchestrator) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
▲ Set_BCSecretKey methodReturn uint32 {'out':True} Parameters Name CIMType ID IN OUT Qualifiers Passphrase string 0 ✓ - {'Description':'Passphrase to use in the computation of the server secret key.','In':True} Force boolean 1 ✓ - {'Description':'Indicates the operation should not prompt for confirmation','In':True}
Description 'Sets the cryptographic key used in the generation of segment secrets.' Set_BCSecretKey method is in 1 class (MSFT_NetBranchCacheOrchestrator) of ROOT\StandardCimv2\MS_409 and in 2 namespaces
Detailed description of MSFT_NetBranchCacheOrchestrator properties Derived properties (4) of MSFT_NetBranchCacheOrchestrator class
▲ ElementName propertyCIMTYPE 'string' Description 'A user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information. Note that the Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties. Note that if there is an associated instance of CIM_EnabledLogicalElementCapabilities, restrictions on this properties may exist as defined in ElementNameMask and MaxElementNameLen properties defined in that class.' ElementName property is in 153 classes of ROOT\StandardCimv2\MS_409 and in 21 namespaces
▲ InstanceID propertyCIMTYPE 'string' Description 'InstanceID is an optional property that may be used to opaquely and uniquely identify an instance of this class within the scope of the instantiating Namespace. Various subclasses of this class may override this property to make it required, or a key. Such subclasses may also modify the preferred algorithms for ensuring uniqueness that are defined below. To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm: : Where and are separated by a colon (:), and where must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the _ structure of Schema class names.) In addition, to ensure uniqueness, must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between and . is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If not null and the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance. If not set to null for DMTF-defined instances, the "preferred" algorithm must be used with the set to CIM.' InstanceID property is in 153 classes of ROOT\StandardCimv2\MS_409 and in 21 namespaces
MSFT_NetBranchCacheOrchestrator Qualifiers Name Value ToInstance ToSubclass Overridable Amended Local
AMENDMENT True ✗ ✗ ✓ ✗ ✓
Description 'BranchCache task orchestrator' ✗ ✓ ✓ ✗ ✓
LOCALE 'MS_409' ✗ ✗ ✓ ✗ ✓
MSFT_NetBranchCacheOrchestrator System properties
Please enable JavaScript to view the comments powered by Disqus.
comments powered by