MSFT_FileDirectoryConfiguration, ROOT\Microsoft\Windows\DesiredStateConfiguration

Class | Methods (3) | Properties (15) | Qualifiers (5) | Instances | Namespaces (2)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

The configuration provider for files and directories.

MSFT_FileDirectoryConfiguration methods

MSFT_FileDirectoryConfiguration has 3 methods (3 Local)

NameOriginReturn
GetTargetResourceMSFT_FileDirectoryConfigurationuint32 {'out':True}
SetTargetResourceMSFT_FileDirectoryConfigurationuint32 {'out':True}
TestTargetResourceMSFT_FileDirectoryConfigurationuint32 {'out':True}

MSFT_FileDirectoryConfiguration properties

MSFT_FileDirectoryConfiguration has 15 properties (15 Local)

NameOriginCIMType
AttributesMSFT_FileDirectoryConfiguration8 [string]
ChecksumMSFT_FileDirectoryConfiguration8 [string]
ContentsMSFT_FileDirectoryConfiguration8 [string]
CreatedDateMSFT_FileDirectoryConfiguration101 [datetime]
CredentialMSFT_FileDirectoryConfiguration13 [object:MSFT_Credential]
key
DestinationPath
MSFT_FileDirectoryConfiguration8 [string]
EnsureMSFT_FileDirectoryConfiguration8 [string]
ForceMSFT_FileDirectoryConfiguration11 [boolean]
MatchSourceMSFT_FileDirectoryConfiguration11 [boolean]
ModifiedDateMSFT_FileDirectoryConfiguration101 [datetime]
RecurseMSFT_FileDirectoryConfiguration11 [boolean]
SizeMSFT_FileDirectoryConfiguration21 [uint64]
SourcePathMSFT_FileDirectoryConfiguration8 [string]
SubItemsMSFT_FileDirectoryConfiguration13 [object:MSFT_FileDirectoryConfiguration]
TypeMSFT_FileDirectoryConfiguration8 [string]

Detailed description of MSFT_FileDirectoryConfiguration methods

Local methods (3) of MSFT_FileDirectoryConfiguration class

GetTargetResource method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
InputResourceobject:MSFT_FileDirectoryConfiguration0-{'Description':'Configuration document that is to be applied.','EmbeddedInstance':'MSFT_FileDirectoryConfiguration','In':True}
Flagsuint321-{'Description':'Flags passed to the providers. Reserved for future use.','In':True}
OutputResourceobject:MSFT_FileDirectoryConfiguration2-{'Description':'The current state of the specified configuration resources.','EmbeddedInstance':'MSFT_FileDirectoryConfiguration','Out':True}
Description'Get resource states based on input configuration file.'
implementedTrue
staticTrue
GetTargetResource method is in 1 class (MSFT_FileDirectoryConfiguration) of ROOT\Microsoft\Windows\DesiredStateConfiguration and in 2 namespaces
SetTargetResource method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
InputResourceobject:MSFT_FileDirectoryConfiguration0-{'Description':'Configuration document that to be applied.','EmbeddedInstance':'MSFT_FileDirectoryConfiguration','In':True}
ProviderContextuint641-{'Description':'Context information that the provider can use to optimize the set from TestTargetResource, This is optional.','In':True}
Flagsuint322-{'Description':'Flags passed to the providers. reserved for future use.','In':True}
Description'Set resource states based on input configuration file.'
implementedTrue
staticTrue
SetTargetResource method is in 1 class (MSFT_FileDirectoryConfiguration) of ROOT\Microsoft\Windows\DesiredStateConfiguration and in 2 namespaces
TestTargetResource method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
InputResourceobject:MSFT_FileDirectoryConfiguration0-{'Description':'Configuration document that to be applied.','EmbeddedInstance':'MSFT_FileDirectoryConfiguration','In':True}
Flagsuint321-{'Description':'Flags passed to the providers. reserved for future use.','In':True}
Resultboolean2-{'Description':'True if identical. False otherwise.','Out':True}
ProviderContextuint643-{'Description':'Context information that the provider can use to optimize the set, This is optional.','Out':True}
Description'Test resource states based on input configuration file.'
implementedTrue
staticTrue
TestTargetResource method is in 1 class (MSFT_FileDirectoryConfiguration) of ROOT\Microsoft\Windows\DesiredStateConfiguration and in 2 namespaces

Detailed description of MSFT_FileDirectoryConfiguration properties

Local properties (15) of MSFT_FileDirectoryConfiguration class

Attributes property
CIMTYPE'string'
Description'Attributes for file / directory'
ValueMap['ReadOnly', 'Hidden', 'System', 'Archive', 'NotContentIndexed']
Values['ReadOnly', 'Hidden', 'System', 'Archive', 'NotContentIndexed']
writeTrue
Attributes property is in 1 class (MSFT_FileDirectoryConfiguration) of ROOT\Microsoft\Windows\DesiredStateConfiguration and in 11 namespaces
Checksum property
CIMTYPE'string'
Description'The checksum type to use when determining whether two files are the same.'
ValueMap['SHA-1', 'SHA-256', 'SHA-512', 'CreatedDate', 'ModifiedDate']
Values['SHA-1', 'SHA-256', 'SHA-512', 'CreatedDate', 'ModifiedDate']
writeTrue
Checksum property is in 1 class (MSFT_FileDirectoryConfiguration) of ROOT\Microsoft\Windows\DesiredStateConfiguration and in 6 namespaces
Contents property
CIMTYPE'string'
Description'Contains a string that represents the contents of the file. To create an empty file, the string must be empty. The contents will be written and compared using UTF-8 character encoding.'
writeTrue
Contents property is in 1 class (MSFT_FileDirectoryConfiguration) of ROOT\Microsoft\Windows\DesiredStateConfiguration and in 2 namespaces
CreatedDate property
CIMTYPE'datetime'
Description'Created date'
readTrue
CreatedDate property is in 1 class (MSFT_FileDirectoryConfiguration) of ROOT\Microsoft\Windows\DesiredStateConfiguration and in 2 namespaces
Credential property
CIMTYPE'object:MSFT_Credential'
Description'Credential to access remote resources.'
EmbeddedInstance'MSFT_Credential'
writeTrue
Credential property is in 2 classes of ROOT\Microsoft\Windows\DesiredStateConfiguration and in 3 namespaces
DestinationPath property
CIMTYPE'string'
Description'File name and path on target node to copy or create.'
keyTrue
DestinationPath property is in 1 class (MSFT_FileDirectoryConfiguration) of ROOT\Microsoft\Windows\DesiredStateConfiguration and in 4 namespaces
Ensure property
CIMTYPE'string'
Description'Defines how to evaluate the existence of the destination file.'
ValueMap['Present', 'Absent']
Values['Present', 'Absent']
writeTrue
Ensure property is in 1 class (MSFT_FileDirectoryConfiguration) of ROOT\Microsoft\Windows\DesiredStateConfiguration and in 2 namespaces
Force property
CIMTYPE'boolean'
Description'Perform the file operation even if it will destroy content files or directories.'
writeTrue
Force property is in 1 class (MSFT_FileDirectoryConfiguration) of ROOT\Microsoft\Windows\DesiredStateConfiguration and in 2 namespaces
MatchSource property
CIMTYPE'boolean'
Description'Always compare the DestinationPath with the SourcePath. The default is false, meaning we will use cached information.'
writeTrue
MatchSource property is in 1 class (MSFT_FileDirectoryConfiguration) of ROOT\Microsoft\Windows\DesiredStateConfiguration and in 2 namespaces
ModifiedDate property
CIMTYPE'datetime'
Description'Modified date'
readTrue
ModifiedDate property is in 1 class (MSFT_FileDirectoryConfiguration) of ROOT\Microsoft\Windows\DesiredStateConfiguration and in 2 namespaces
Recurse property
CIMTYPE'boolean'
Description'Recurse all child directories'
writeTrue
Recurse property is in 1 class (MSFT_FileDirectoryConfiguration) of ROOT\Microsoft\Windows\DesiredStateConfiguration and in 2 namespaces
Size property
CIMTYPE'uint64'
Description'Object size'
readTrue
Size property is in 1 class (MSFT_FileDirectoryConfiguration) of ROOT\Microsoft\Windows\DesiredStateConfiguration and in 16 namespaces
SourcePath property
CIMTYPE'string'
Description'The name and path of the file to copy from.'
writeTrue
SourcePath property is in 1 class (MSFT_FileDirectoryConfiguration) of ROOT\Microsoft\Windows\DesiredStateConfiguration and in 4 namespaces
SubItems property
CIMTYPE'object:MSFT_FileDirectoryConfiguration'
Description'The sub-folders and files if this is a directory.'
EmbeddedInstance'MSFT_FileDirectoryConfiguration'
readTrue
SubItems property is in 1 class (MSFT_FileDirectoryConfiguration) of ROOT\Microsoft\Windows\DesiredStateConfiguration and in 2 namespaces
Type property
CIMTYPE'string'
Description'A choice between File and Directory. The default value is File.'
ValueMap['File', 'Directory']
Values['File', 'Directory']
writeTrue
Type property is in 2 classes of ROOT\Microsoft\Windows\DesiredStateConfiguration and in 142 namespaces

MSFT_FileDirectoryConfiguration Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
ClassVersion'1.0.0'
Description'The configuration provider for files and directories.'
dynamicTrue
locale'MS_409'
provider'DSCCoreProviders'

MSFT_FileDirectoryConfiguration System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\Microsoft\Windows\DesiredStateConfiguration:MSFT_FileDirectoryConfiguration'___SYSTEM8
__NAMESPACE'ROOT\Microsoft\Windows\DesiredStateConfiguration'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['OMI_BaseResource']___SYSTEM8
__PROPERTY_COUNT15___SYSTEM3
__RELPATH'MSFT_FileDirectoryConfiguration'___SYSTEM8
__DYNASTY'OMI_BaseResource'___SYSTEM8
__SUPERCLASS'OMI_BaseResource'___SYSTEM8
__CLASS'MSFT_FileDirectoryConfiguration'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to MSFT_FileDirectoryConfiguration

Number of classes:2
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
MSFT_DSCLocalConfigurationManager0010----
MSFT_DSCMetaConfiguration0110----
comments powered by Disqus
WUtils.com