DSC-fájlerőforrás

Cikk
04/06/2023

Érintett kiadások: Windows PowerShell 4.0, Windows PowerShell 5.x

A Windows PowerShell Desired State Configuration fájlerőforrása (DSC) egy mechanizmust biztosít a célcsomópont fájljainak és mappáinak kezelésére. A Célútvonalnak és a SourcePath-nak egyaránt elérhetőnek kell lennie a célcsomópont számára.

Megjegyzés

A DSC-erőforrás dokumentációja a PowerShell 7.2-es verzió előtti verzióját ismerteti. A PSDscResources modul a Microsoft által hivatalosan támogatott új és frissített DSC-erőforrásokat tartalmaz. A PSDscResources modul a PowerShell-galéria érhető el.

További információkért és a frissített dokumentációért tekintse meg a PSDscResources referenciadokumentációját.

Syntax

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] ]
    [ Force = [bool] ]
    [ Recurse = [bool] ]
    [ SourcePath = [string] ]
    [ Type = [string] { Directory | File } ]
    [ MatchSource = [bool] ]
    [ DependsOn = [string[]] ]
    [ Ensure = [string] { Absent | Present } ]
    [ PsDscRunAsCredential = [PSCredential] ]
}

Tulajdonságok

Tulajdonság	Leírás
DestinationPath	A célcsomóponton található hely, amelyről gondoskodni szeretne, hogy a Jelen legyen vagy a Hiányzása következővel: Győződjön meg róla.
Attribútumok	A megcélzott fájl vagy könyvtár attribútumainak kívánt állapota. Az érvényes értékek az Archív, a Rejtett, a ReadOnly és a System.
Ellenőrzőösszeg	A két fájl azonosságának megállapításához használandó ellenőrzőösszeg-típus. Az érvényes értékek a következők: SHA-1, SHA-256, SHA-512, createdDate, modifiedDate.
Tartalom	Csak akkor érvényes, ha atípusfájllal használja. Azt jelzi , hogy a célfájl tartalma jelen van-e vagy hiányzik - e.
Hitelesítő adat	Az erőforrások, például a forrásfájlok eléréséhez szükséges hitelesítő adatok.
Force	Felülbírálja azokat a hozzáférési műveleteket, amelyek hibát okozhatnak (például felülírnak egy fájlt vagy törölnek egy nem üres könyvtárat). Az alapértelmezett érték `$false`.
Ismétlődés	Csak a TypeDirectoryval való használat esetén érvényes. Rekurzív módon hajtja végre az állapotműveletet az összes könyvtártartalomra, alkönyvtárra és alkönyvtár-tartalomra. Az alapértelmezett érték `$false`.
SourcePath	A fájl- vagy mappaerőforrás másolási útvonala.
Típus	A konfigurált erőforrás típusa. Az érvényes értékek a Könyvtár és a Fájl. Az alapértelmezett érték a Fájl.
MatchSource	Meghatározza, hogy az erőforrásnak figyelnie kell-e a forráskönyvtárba a kezdeti másolás után hozzáadott új fájlokat. A értéke `$true` azt jelzi, hogy a kezdeti másolás után minden új forrásfájlt át kell másolni a célhelyre. Ha a értékre `$false`van állítva, az erőforrás gyorsítótárazza a forráskönyvtár tartalmát, és figyelmen kívül hagyja a kezdeti másolás után hozzáadott fájlokat. Az alapértelmezett érték `$false`.

Figyelmeztetés

Ha nem ad meg értéket a hitelesítő adatokhoz vagy a PSRunAsCredentialhoz, az erőforrás a célcsomópont számítógépfiókját fogja használni a SourcePath eléréséhez. Ha a SourcePath UNC-megosztás, ez "Hozzáférés megtagadva" hibát eredményezhet. Győződjön meg arról, hogy az engedélyek megfelelően vannak beállítva, vagy használja a Hitelesítő adatok vagy a PSRunAsCredential tulajdonságokat a használni kívánt fiók megadásához.

Közös tulajdonságok

Tulajdonság	Leírás
DependsOn	Azt jelzi, hogy egy másik erőforrás konfigurációjának futnia kell az erőforrás konfigurálása előtt. Ha például az először futtatni kívánt erőforrás-konfigurációs szkriptblokk azonosítója ResourceName, és a típusa ResourceType, akkor a tulajdonság használatának szintaxisa a következő `DependsOn = "[ResourceType]ResourceName"`: .
Biztosítja	Meghatározza, hogy a célhelyen lévő fájlnak és tartalomnak léteznie kell-e. Állítsa ezt a tulajdonságot Present (Jelen) értékre a fájl meglétének ellenőrzéséhez. A Hiányzó értékre állítva győződjön meg arról, hogy nem léteznek. Az alapértelmezett érték a Jelenik.
PsDscRunAsCredential	Beállítja a teljes erőforrás futtatásához szükséges hitelesítő adatokat.

Megjegyzés

A PsDscRunAsCredential közös tulajdonság hozzáadva a WMF 5.0-hoz, hogy bármely DSC-erőforrást más hitelesítő adatok kontextusában futtathasson. További információ: Hitelesítő adatok használata DSC-erőforrásokkal.

További információ

Ha csak DestinationPath értéket ad meg, az erőforrás biztosítja, hogy az elérési út létezik, ha jelen van, vagy ha hiányzik, akkor nem létezik.
Amikor megad egy SourcePath és egy DestinationPath értéket a DirectoryTípus értékével, az erőforrás átmásolja a forráskönyvtárat a cél elérési útjára. A Recurse, Force és MatchSource tulajdonságok megváltoztatják a végrehajtott másolási műveletet, míg a hitelesítő adatok határozzák meg, hogy melyik fiókot kell használni a forráskönyvtár eléréséhez.
Ha nem állítja be a Recurse tulajdonságot $true a könyvtár másolása során, a rendszer a meglévő könyvtár egyik tartalmát sem másolja át. A program csak a megadott könyvtárat másolja.
Ha a DestinationPath tulajdonság mellett a ReadOnly értéket adta meg az Attribútumok tulajdonsághoz, akkor a Jelen állapot beállításakor létrejön a megadott elérési út, míg a Tartalom a fájl tartalmát állítja be. A Hiányzás biztosítása beállítás teljes egészében figyelmen kívül hagyja az Attribútumok tulajdonságot, és eltávolítja a megadott elérési úton lévő fájlokat.

Példa

Az alábbi példa egy könyvtárat és annak alkönyvtárait másolja egy lekérési kiszolgálóról egy célcsomópontra a Fájlerőforrás használatával. Ha a művelet sikeres, a naplóerőforrás megerősítő üzenetet ír az eseménynaplóba.

A forráskönyvtár a lekéréses kiszolgálóról megosztott UNC elérési út (\\PullServer\DemoSource). A Recurse tulajdonság biztosítja, hogy az alkönyvtárak is másolva legyenek.

Fontos

A célcsomópont LCM-jének végrehajtása alapértelmezés szerint a helyi rendszerfiók környezetében történik. A SourcePath-hoz való hozzáférés biztosításához adjon megfelelő engedélyeket a célcsomópont számítógépfiókjának. A hitelesítő adatok és a PSDSCRunAsCredential egyaránt módosítják azt a környezetet, amelyet az LCM a SourcePath eléréséhez használ. Továbbra is hozzáférést kell adnia ahhoz a fiókhoz, amely a SourcePath eléréséhez lesz használva.

Configuration FileResourceDemo
{
    Import-DscResource -ModuleName 'PSDesiredStateConfiguration'

    Node "localhost"
    {
        File DirectoryCopy
        {
            Ensure = "Present" # Ensure the directory is Present on the target node.
            Type = "Directory" # The default is File.
            Recurse = $true # Recursively copy all subdirectories.
            SourcePath = "\\PullServer\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" # Depends on successful execution of the File resource.
        }
    }
}

A hitelesítő adatok DSC-ben való használatáról további információt a Futtató felhasználó vagy a Konfigurációs adatok hitelesítő adatai című témakörben talál.

Share via