複合資源：把 DSC 設定當做資源使用

  • 發行項

適用於：Windows PowerShell 4.0、Windows PowerShell 5.0

在真實世界的情況裡，設定可能冗長且複雜，要呼叫許多不同的資源，並設定大量的屬性。 為解決這種複雜性，您可以使用 Windows PowerShell 預期狀態設定 (DSC) 設定作為其他設定的資源。 這稱為複合資源。 複合資源是使用參數的 DSC 設定。 設定參數的表現如同資源屬性。 設定會儲存為副檔名為 .schema.psm1 的檔案。 它會取代 MOF 結構描述和一般 DSC 資源中的資源指令碼。 如需有關 DSC 資源的詳細資訊，請參閱 Windows PowerShell 預期狀態設定資源。

建立複合資源

在範例中，我們會建立叫用許多現有資源的設定來設定虛擬機器。 不指定要在設定區塊中設定的值，而是讓設定接受之後在設定區塊中使用的參數。

Configuration xVirtualMachine
{
    param
    (
        # Name of VMs
        [Parameter(Mandatory)]
        [ValidateNotNullOrEmpty()]
        [String[]] $VMName,

        # Name of Switch to create
        [Parameter(Mandatory)]
        [ValidateNotNullOrEmpty()]
        [String] $SwitchName,

        # Type of Switch to create
        [Parameter(Mandatory)]
        [ValidateNotNullOrEmpty()]
        [String] $SwitchType,

        # Source Path for VHD
        [Parameter(Mandatory)]
        [ValidateNotNullOrEmpty()]
        [String] $VHDParentPath,

        # Destination path for diff VHD
        [Parameter(Mandatory)]
        [ValidateNotNullOrEmpty()]
        [String] $VHDPath,

        # Startup Memory for VM
        [Parameter(Mandatory)]
        [ValidateNotNullOrEmpty()]
        [String] $VMStartupMemory,

        # State of the VM
        [Parameter(Mandatory)]
        [ValidateNotNullOrEmpty()]
        [String] $VMState
    )

    # Import the module that defines custom resources
    Import-DSCResource -ModuleName xComputerManagement,xHyper-V

    # Install the Hyper-V role
    WindowsFeature HyperV
    {
        Ensure = "Present"
        Name = "Hyper-V"
    }

    # Create the virtual switch
    xVMSwitch $SwitchName
    {
        Ensure = "Present"
        Name = $SwitchName
        Type = $SwitchType
        DependsOn = "[WindowsFeature]HyperV"
    }

    # Check for Parent VHD file
    File ParentVHDFile
    {
        Ensure = "Present"
        DestinationPath = $VHDParentPath
        Type = "File"
        DependsOn = "[WindowsFeature]HyperV"
    }

    # Check the destination VHD folder
    File VHDFolder
    {
        Ensure = "Present"
        DestinationPath = $VHDPath
        Type = "Directory"
        DependsOn = "[File]ParentVHDFile"
    }

    # Create VM specific diff VHD
    foreach ($Name in $VMName)
    {
        xVHD "VHD$Name"
        {
            Ensure = "Present"
            Name = $Name
            Path = $VHDPath
            ParentPath = $VHDParentPath
            DependsOn = @("[WindowsFeature]HyperV",
                          "[File]VHDFolder")
        }
    }

    # Create VM using the above VHD
    foreach($Name in $VMName)
    {
        xVMHyperV "VMachine$Name"
        {
            Ensure = "Present"
            Name = $Name
            VhDPath = (Join-Path -Path $VHDPath -ChildPath $Name)
            SwitchName = $SwitchName
            StartupMemory = $VMStartupMemory
            State = $VMState
            MACAddress = $MACAddress
            WaitForIP = $true
            DependsOn = @("[WindowsFeature]HyperV",
                          "[xVHD]VHD$Name")
        }
    }
}

注意

DSC 目前不支援將複合資源或巢狀設定放在複合資源內。

將設定儲存為複合資源

若要使用參數化設定作為 DSC 資源，請將它儲存在類似任何其他 MOF 型資源之目錄結構的目錄結構中，然後以 .schema.psm1 附檔名為其命名。 針對此範例，我們會將檔案命名為 xVirtualMachine.schema.psm1。 您還必須建立名為 xVirtualMachine.psd1 且包含下列行的資訊清單。

RootModule = 'xVirtualMachine.schema.psm1'

注意

這是 MyDscResources.psd1 (MyDscResources 資料夾底下所有資源的模組資訊清單) 以外的資訊清單。

完成之後，資料夾結構應如下。

$env: psmodulepath
    |- MyDscResources
        |- MyDscResources.psd1
        |- DSCResources
            |- xVirtualMachine
                |- xVirtualMachine.psd1
                |- xVirtualMachine.schema.psm1

現在可使用 Get-DscResource Cmdlet 來探索資源，也可使用該 Cmdlet 或在 Windows PowerShell ISE 中使用 Ctrl+空格鍵自動完成來探索其屬性。

使用複合資源

接下來我們要建立呼叫複合資源的設定。 這個設定會呼叫 xVirtualMachine 複合資源，以建立虛擬機器，然後再呼叫 xComputer 資源重新命名它。

configuration RenameVM
{
    Import-DSCResource -ModuleName xVirtualMachine
    Node localhost
    {
        xVirtualMachine VM
        {
            VMName = "Test"
            SwitchName = "Internal"
            SwitchType = "Internal"
            VhdParentPath = "C:\Demo\VHD\RTM.vhd"
            VHDPath = "C:\Demo\VHD"
            VMStartupMemory = 1024MB
            VMState = "Running"
        }
    }

    Node "192.168.10.1"
    {
        xComputer Name
        {
            Name = "SQL01"
            DomainName = "fourthcoffee.com"
        }
    }
}

您也可以使用此資源來建立多部 VM，只要將 VM 名稱的陣列傳遞給 xVirtualMachine 資源即可。

Configuration MultipleVms
{
    Import-DSCResource -ModuleName xVirtualMachine
    Node localhost
    {
        xVirtualMachine VMs
        {
            VMName = "IIS01", "SQL01", "SQL02"
            SwitchName = "Internal"
            SwitchType = "Internal"
            VhdParentPath = "C:\Demo\VHD\RTM.vhd"
            VHDPath = "C:\Demo\VHD"
            VMStartupMemory = 1024MB
            VMState = "Running"
        }
    }
}

支援 PsDscRunAsCredential

注意

PowerShell 5.0 或更新版本中支援 PsDscRunAsCredential。

您可以在 DSC 設定資源區塊中使用 PsDscRunAsCredential 特性，以指定該資源應該在一組指定的認證下執行。 如需詳細資訊，請參閱以使用者認證執行 DSC。

若要從自訂資源內存取使用者內容，您可以使用自動變數 $PsDscContext。

例如，下列程式碼會將資源執行位置的上層使用者內容寫入到詳細的輸出資料流：

if ($PsDscContext.RunAsUser) {
    Write-Verbose "User: $PsDscContext.RunAsUser";
}

另請參閱

概念