DSC-bestandsbronDSC File Resource

Van toepassing op: Windows PowerShell 4.0, Windows PowerShell 5.0Applies To: Windows PowerShell 4.0, Windows PowerShell 5.0

De bron van het bestand in Windows PowerShell Desired State Configuration (DSC) biedt een mechanisme voor het beheren van bestanden en mappen op het doelknooppunt.The File resource in Windows PowerShell Desired State Configuration (DSC) provides a mechanism to manage files and folders on the target node.

Opmerking: als de MatchSource eigenschap is ingesteld op $false (dit is de standaardwaarde), de inhoud te kopiëren de eerste keer dat de configuratie is toegepast in cache zijn opgeslagen.Note: If the MatchSource property is set to $false (which is the default value), the contents to be copied are cached the first time the configuration is applied. Volgende aanvragen van de configuratie wordt niet gecontroleerd op bijgewerkte bestanden en/of mappen in het pad dat is opgegeven door bronpad.Subsequent applications of the configuration will not check for updated files and/or folders in the path specified by SourcePath. Als u wilt controleren op updates voor de bestanden en/of mappen in bronpad ingesteld telkens wanneer de configuratie is toegepast, MatchSource naar $true.If you want to check for updates to the files and/or folders in SourcePath every time the configuration is applied, set MatchSource to $true.

SyntaxisSyntax

File [string] #ResourceName
{
    DestinationPath = [string]
    [ Attributes = [string[]] { Archive | Hidden | ReadOnly | System }]
    [ Checksum = [string] { CreatedDate | ModifiedDate | SHA-1 | SHA-256 | SHA-512 } ]
    [ Contents = [string] ]
    [ Credential = [PSCredential] ]
    [ Ensure = [string] { Absent | Present } ]
    [ Force = [bool] ]
    [ Recurse = [bool] ]
    [ DependsOn = [string[]] ]
    [ SourcePath = [string] ]
    [ Type = [string] { Directory | File } ]
    [ MatchSource = [bool] ]
}

EigenschappenProperties

EigenschapProperty BeschrijvingDescription
DestinationPathDestinationPath Geeft de locatie waar u Zorg ervoor dat de status voor een bestand of map.Indicates the location where you want to ensure the state for a file or directory.
KenmerkenAttributes Hiermee geeft u de gewenste status van de kenmerken voor het betreffende bestand of map.Specifies the desired state of the attributes for the targeted file or directory.
ControlesomChecksum Geeft het type controlesom kunt bepalen of twee bestanden hetzelfde zijn.Indicates the checksum type to use when determining whether two files are the same. Als controlesom niet is opgegeven, alleen de naam van bestand of map wordt gebruikt voor vergelijking.If Checksum is not specified, only the file or directory name is used for comparison. Geldige waarden zijn: SHA-1, SHA-256, SHA-512, createdDate, modifiedDate.Valid values include: SHA-1, SHA-256, SHA-512, createdDate, modifiedDate.
InhoudContents Hiermee geeft u de inhoud van een bestand, zoals een bepaalde tekenreeks.Specifies the contents of a file, such as a particular string.
referentieCredential Geeft de referenties die vereist voor toegang tot bronnen, zoals de bronbestanden bevat zijn, of deze toegang vereist is.Indicates the credentials that are required to access resources, such as source files, if such access is required.
Zorg ervoor datEnsure Hiermee wordt aangegeven of het bestand of map bestaat.Indicates if the file or directory exists. Deze eigenschap instellen op 'Ontbreekt' om ervoor te zorgen dat het bestand of map niet bestaat.Set this property to "Absent" to ensure that the file or directory does not exist. Stel deze in op 'Aanwezig' om ervoor te zorgen dat het bestand of map bestaat.Set it to "Present" to ensure that the file or directory does exist. De standaardwaarde is 'Aanwezig'.The default is "Present".
ForceForce Bepaalde bestandsbewerkingen (zoals een bestand te overschrijven of verwijderen van een map die is niet leeg) leidt tot een fout opgetreden.Certain file operations (such as overwriting a file or deleting a directory that is not empty) will result in an error. Met de eigenschap Force, overschrijft dergelijke fouten.Using the Force property overrides such errors. De standaardwaarde is $false.The default value is $false.
RecurseRecurse Hiermee wordt aangegeven als submappen opgenomen worden.Indicates if subdirectories are included. Deze eigenschap instellen op $true om aan te geven dat u wilt dat de submappen worden opgenomen.Set this property to $true to indicate that you want subdirectories to be included. De standaardwaarde is $false.The default is $false. Opmerking: deze eigenschap is alleen geldig wanneer de eigenschap Type is ingesteld op de Directory.Note: This property is only valid when the Type property is set to Directory.
dependsOnDependsOn Hiermee wordt aangegeven dat de configuratie van een andere resource uitvoeren moet voordat deze bron is geconfigureerd.Indicates that the configuration of another resource must run before this resource is configured. Bijvoorbeeld, als de ID van de resourceconfiguratie scriptblok die u wilt uitvoeren eerst is ResourceName en het type ResourceType, de syntaxis voor het gebruik van deze eigenschap is DependsOn = "[ResourceType]ResourceName".For example, if the ID of the resource configuration script block that you want to run first is ResourceName and its type is ResourceType, the syntax for using this property is DependsOn = "[ResourceType]ResourceName".
BronpadSourcePath Geeft het pad van waaruit de bron van het bestand of map kopiëren.Indicates the path from which to copy the file or folder resource.
TypeType Hiermee wordt aangegeven of de resource die wordt geconfigureerd een map of een bestand is.Indicates if the resource being configured is a directory or a file. Deze eigenschap instellen op 'Map' om aan te geven dat de resource een map is.Set this property to "Directory" to indicate that the resource is a directory. Stel deze in op 'File' om aan te geven dat de resource een bestand is.Set it to "File" to indicate that the resource is a file. De standaardwaarde is 'File'.The default value is “File”.
MatchSourceMatchSource Indien ingesteld op de standaardwaarde van $false, en vervolgens alle bestanden op de bron (bijvoorbeeld bestanden A, B en C) wordt toegevoegd aan het doel de eerste keer dat de configuratie is toegepast.If set to the default value of $false, then any files on the source (say, files A, B, and C) will be added to the destination the first time the configuration is applied. Als een nieuw bestand (D) wordt toegevoegd aan de bron, het niet toegevoegd aan de bestemming, zelfs wanneer de configuratie wordt later opnieuw toegepast.If a new file (D) is added to the source, it will not be added to the destination, even when the configuration is re-applied later. Als de waarde $true, en vervolgens elke keer dat de configuratie is toegepast, nieuwe bestanden vervolgens gevonden op de bron (zoals bestand D in dit voorbeeld) worden toegevoegd aan de bestemming.If the value is $true, then each time the configuration is applied, new files subsequently found on the source (such as file D in this example) are added to the destination. De standaardwaarde is $false.The default value is $false.

VoorbeeldExample

Het volgende voorbeeld ziet u hoe u de bron van het bestand gebruikt om ervoor te zorgen dat een map met het pad C:\Users\Public\Documents\DSCDemo\DemoSource in een bron computer (zoals de server 'pull') is ook aanwezig zijn (samen met alle submappen) in het doelknooppunt.The following example shows how to use the File resource to ensure that a directory with the path C:\Users\Public\Documents\DSCDemo\DemoSource on a source computer (such as the “pull” server) is also present (along with all subdirectories) on the target node. Ook een bevestiging bericht schrijft naar het logboek na afloop en bevat een instructie om ervoor te zorgen dat de bestandscontrole bewerking wordt uitgevoerd voordat de bewerking voor logboekregistratie.It also writes a confirmatory message to the log when complete and includes a statement to ensure that the file-checking operation runs prior to the logging operation.

Configuration FileResourceDemo
{
    Node "localhost"
    {
        File DirectoryCopy
        {
            Ensure = "Present"  # You can also set Ensure to "Absent"
            Type = "Directory" # Default is "File".
            Recurse = $true # Ensure presence of subdirectories, too
            SourcePath = "C:\Users\Public\Documents\DSCDemo\DemoSource"
            DestinationPath = "C:\Users\Public\Documents\DSCDemo\DemoDestination"
        }

        Log AfterDirectoryCopy
        {
            # The message below gets written to the Microsoft-Windows-Desired State Configuration/Analytic log
            Message = "Finished running the file resource with ID DirectoryCopy"
            DependsOn = "[File]DirectoryCopy" # This means run "DirectoryCopy" first.
        }
    }
}