{"id":1801,"date":"2014-02-25T21:33:00","date_gmt":"2014-02-25T21:33:00","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/powershell\/2014\/02\/25\/reusing-existing-configuration-scripts-in-powershell-desired-state-configuration\/"},"modified":"2024-02-22T11:24:57","modified_gmt":"2024-02-22T19:24:57","slug":"reusing-existing-configuration-scripts-in-powershell-desired-state-configuration","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/powershell\/reusing-existing-configuration-scripts-in-powershell-desired-state-configuration\/","title":{"rendered":"Reusing Existing Configuration Scripts in PowerShell Desired State Configuration"},"content":{"rendered":"
\n

You are an expert in PowerShell DSC (or maybe not an expert, just someone playing around with configurations in DSC) and have already written fairly large and complex configurations for configuring your environment\/data center. Everything is working well and you are a great fan of DSC. There\u2019s only one problem: your work is complicated<\/em>. Before long, you have a configuration that is hundreds or thousands of lines long \u2013 people from many different teams are editing it. Finding and fixing problems becomes nearly impossible\u2026 your configuration is just too unwieldy<\/em>. Then comes a day when there arises a need to add something more (or maybe delete something) to your configuration. The problem looks trivial to solve right? \u2013Just add one more resource to your (already big) configuration. But you are a forward thinking person and find yourself wondering if there is something clever you can do leverage your existing configuration scripts.<\/p>\n

That is why we made configurations composable<\/strong> and reusable<\/strong>J<\/span>. Yes, one configuration can call another. How? That is what we are going to cover in this post.<\/p>\n

\n

The way to make a configuration reusable is by making it what we call a composite resource<\/strong>. Let me walk you through an example to do just that.<\/p>\n

\n

I have the following parameterized configuration (the parameters of the configuration become the properties of the composite resource) which I will turn into a composite resource:<\/p>\n

\n

Configuration<\/span> xVirtualMachine<\/span><\/span><\/p>\n

{<\/span><\/p>\n

\n

param<\/span><\/span><\/p>\n<\/blockquote>\n

\n

(<\/span><\/p>\n<\/blockquote>\n

\n

# Name of VMs<\/span><\/span><\/p>\n<\/blockquote>\n

\n

[<\/span>Parameter<\/span>(Mandatory)]<\/span><\/span><\/p>\n<\/blockquote>\n

\n

[<\/span>ValidateNotNullOrEmpty<\/span>()]<\/span><\/span><\/p>\n<\/blockquote>\n

\n

[<\/span>String<\/span>[]]<\/span>$VMName<\/span>,<\/span><\/span><\/p>\n<\/blockquote>\n

\u00a0<\/span><\/p>\n

\n

# Name of Switch to create<\/span><\/span><\/p>\n<\/blockquote>\n

\n

[<\/span>Parameter<\/span>(Mandatory)]<\/span><\/span><\/p>\n<\/blockquote>\n

\n

[<\/span>ValidateNotNullOrEmpty<\/span>()]<\/span><\/span><\/p>\n<\/blockquote>\n

\n

[<\/span>String<\/span>]<\/span>$SwitchName<\/span>,<\/span><\/span><\/p>\n<\/blockquote>\n

\u00a0<\/span><\/p>\n

\n

# Type of Switch to create<\/span><\/span><\/p>\n<\/blockquote>\n

\n

[<\/span>Parameter<\/span>(Mandatory)]<\/span><\/span><\/p>\n<\/blockquote>\n

\n

[<\/span>ValidateNotNullOrEmpty<\/span>()]<\/span><\/span><\/p>\n<\/blockquote>\n

\n

[<\/span>String<\/span>]<\/span>$SwitchType<\/span>,<\/span><\/span><\/p>\n<\/blockquote>\n

\u00a0<\/span><\/p>\n

\n

# Source Path for VHD<\/span><\/span><\/p>\n<\/blockquote>\n

\n

[<\/span>Parameter<\/span>(Mandatory)]<\/span><\/span><\/p>\n<\/blockquote>\n

\n

[<\/span>ValidateNotNullOrEmpty<\/span>()]<\/span><\/span><\/p>\n<\/blockquote>\n

\n

[<\/span>String<\/span>]<\/span>$VhdParentPath<\/span>,<\/span><\/span><\/p>\n<\/blockquote>\n

\u00a0<\/span><\/p>\n

\n

# Destination path for diff VHD<\/span><\/span><\/p>\n<\/blockquote>\n

\n

[<\/span>Parameter<\/span>(Mandatory)]<\/span><\/span><\/p>\n<\/blockquote>\n

\n

[<\/span>ValidateNotNullOrEmpty<\/span>()]<\/span><\/span><\/p>\n<\/blockquote>\n

\n

[<\/span>String<\/span>]<\/span>$VHDPath<\/span>,<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\n

# Startup Memory for VM<\/span><\/span><\/p>\n<\/blockquote>\n

\n

[<\/span>Parameter<\/span>(Mandatory)]<\/span><\/span><\/p>\n<\/blockquote>\n

\n

[<\/span>ValidateNotNullOrEmpty<\/span>()]<\/span><\/span><\/p>\n<\/blockquote>\n

\n

[<\/span>String<\/span>]<\/span>$VMStartupMemory<\/span>,<\/span><\/span><\/p>\n<\/blockquote>\n

\u00a0<\/span><\/p>\n

\n

# State of the VM<\/span><\/span><\/p>\n<\/blockquote>\n

\n

[<\/span>Parameter<\/span>(Mandatory)]<\/span><\/span><\/p>\n<\/blockquote>\n

\n

[<\/span>ValidateNotNullOrEmpty<\/span>()]<\/span><\/span><\/p>\n<\/blockquote>\n

\n

[<\/span>String<\/span>]<\/span>$VMState<\/span><\/span><\/p>\n<\/blockquote>\n

\n

)<\/span><\/p>\n<\/blockquote>\n

\u00a0<\/span><\/p>\n

\n

# Import the module that defines custom resources<\/span><\/span><\/p>\n<\/blockquote>\n

\n

Import-DscResource<\/span> -Module<\/span> xComputerManagement<\/span>,<\/span>xHyper-V<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\n

# Install the HyperV role <\/span><\/span><\/p>\n<\/blockquote>\n

\n

WindowsFeature<\/span> HyperV<\/span><\/span><\/p>\n<\/blockquote>\n

\n

{<\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0 Ensure<\/span> =<\/span> “Present”<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0 Name<\/span> =<\/span> “Hyper-V”<\/span> <\/span><\/p>\n<\/blockquote>\n

\n

}<\/span><\/p>\n<\/blockquote>\n

\n

\n

# Create the virtual switch <\/span><\/span><\/p>\n<\/blockquote>\n

\n

xVMSwitch<\/span> $switchName<\/span><\/span><\/p>\n<\/blockquote>\n

\n

{<\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0 Ensure<\/span> =<\/span> “Present”<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0 Name<\/span> =<\/span> $switchName<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0 Type<\/span> =<\/span> $SwitchType<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0 DependsOn<\/span> =<\/span> “[WindowsFeature]HyperV”<\/span><\/span><\/p>\n<\/blockquote>\n

\n

}<\/span><\/p>\n<\/blockquote>\n

\u00a0<\/span><\/p>\n

\n

# Check for Parent VHD file<\/span><\/span><\/p>\n<\/blockquote>\n

\n

File<\/span> ParentVHDFile<\/span><\/span><\/p>\n<\/blockquote>\n

\n

{<\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0 Ensure<\/span> =<\/span> “Present”<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0 DestinationPath<\/span> =<\/span> $VhdParentPath<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0 Type<\/span> =<\/span> “File”<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0 DependsOn<\/span> =<\/span> “[WindowsFeature]HyperV”<\/span><\/span><\/p>\n<\/blockquote>\n

\n

}<\/span><\/p>\n<\/blockquote>\n

\n

\u00a0<\/span><\/p>\n

# Check the destination VHD folder<\/span><\/span><\/p>\n<\/blockquote>\n

\n

File<\/span> VHDFolder<\/span><\/span><\/p>\n<\/blockquote>\n

\n

{<\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0 Ensure<\/span> =<\/span> “Present”<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0 DestinationPath<\/span> =<\/span> $VHDPath<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0 Type<\/span> =<\/span> “Directory”<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0 DependsOn<\/span> =<\/span> “[File]ParentVHDFile”<\/span><\/span><\/p>\n<\/blockquote>\n

\n

}<\/span><\/p>\n<\/blockquote>\n

\u00a0<\/span><\/p>\n

\n

\u00a0<\/span># Creae VM specific diff VHD<\/span><\/span><\/p>\n<\/blockquote>\n

\n

foreach<\/span>($Name<\/span> in<\/span> $VMName<\/span>)<\/span><\/p>\n<\/blockquote>\n

\n

{<\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0 xVHD<\/span> “VhD<\/span>$Name<\/span>“<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0 {<\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Ensure<\/span> =<\/span> “Present”<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Name<\/span> =<\/span> $Name<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Path<\/span> =<\/span> $VhDPath<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 ParentPath<\/span> =<\/span> $VhdParentPath<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 DependsOn<\/span> =<\/span> @(“[WindowsFeature]HyperV”<\/span>,<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 “[File]VHDFolder”<\/span>)<\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0 }<\/span><\/p>\n<\/blockquote>\n

\n

}<\/span><\/p>\n<\/blockquote>\n

\u00a0<\/span><\/p>\n

\n

# Create VM using the above VHD<\/span><\/span><\/p>\n<\/blockquote>\n

\n

foreach<\/span>($Name<\/span> in<\/span> $VMName<\/span>)<\/span><\/p>\n<\/blockquote>\n

\n

{<\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0 xVMHyperV<\/span> “VMachine<\/span>$Name<\/span>“<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0 {<\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Ensure<\/span> =<\/span> “Present”<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Name<\/span> =<\/span> $Name<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 VhDPath<\/span> =<\/span> (Join-Path<\/span> -Path<\/span> $VhDPath<\/span> -ChildPath<\/span> $Name<\/span>)<\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 SwitchName<\/span> =<\/span> $SwitchName<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 StartupMemory<\/span> =<\/span> $VMStartupMemory<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 State<\/span> =<\/span> $VMState<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 MACAddress<\/span> =<\/span> $MACAddress<\/span> <\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 WaitForIP<\/span> =<\/span> $true<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 DependsOn<\/span> =<\/span> @(“[WindowsFeature]HyperV”<\/span>,<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 “[xVHD]Vhd<\/span>$Name<\/span>“<\/span>)<\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0 }<\/span><\/p>\n<\/blockquote>\n

\n

} <\/span><\/p>\n<\/blockquote>\n

} <\/span><\/p>\n

\n

The key is to place the configuration in a file with the extension schema.psm1<\/strong>. You can take a look here<\/a> to find out how to deploy a DSC Resource. Here is how it looks on my machine:<\/span><\/p>\n

PS C:\\Program Files\\WindowsPowerShell\\Modules\\TestCompositeResource\\DSCResources\\xVirtualMachine> dir<\/span><\/p>\n

\u00a0\u00a0\u00a0 Directory: C:\\Program Files\\WindowsPowerShell\\Modules\\TestCompositeResource\\DSCResources\\xVirtualMachine<\/span><\/p>\n

Mode\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 LastWriteTime\u00a0\u00a0\u00a0\u00a0 Length Name\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span><\/p>\n

—-\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 ————-\u00a0\u00a0\u00a0\u00a0 —— —-\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span><\/p>\n

-a—\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 2\/25\/2014\u00a0\u00a0 8:42 PM\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 2642 xVirtualMachine.psd1\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span><\/p>\n

-a—\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 2\/25\/2014\u00a0\u00a0 8:42 PM\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 2957 xVirtualMachine.schema.psm1\u00a0\u00a0\u00a0<\/span><\/p>\n

Note: Take note of the .psd1 file (xVirtualMachine.psd1) inside the DSCResources folder. On my first attempt, I did not put that file in there and wasted some time trying to figure out where I was going wrong (yes, yes, yes a valid PowerShell module must have one out of .psd1, .psm1, .cdxml, .dll extension and it took me some time to figure out the fact that .schema.psm1 does not satisfy that condition).<\/em><\/span><\/p>\n

Inside the .psd1 file, I have this line:<\/span><\/p>\n

RootModule =<\/span> ‘xVirtualMachine.schema.psm1’ <\/span><\/span><\/p>\n

\n

That is it, you are done!<\/span><\/p>\n

Edit: For the resource to be discoverable and usable, it must be part of a valid PowerShell module.\u00a0 For this example to work, you would also need to create a TestCompositeResource.psd1 module manifest under the “TestCompositeResource” Folder.\u00a0 The best way to do that is by running “New-ModuleManifest -path “C:\\Program Files\\WindowsPowerShell\\Modules\\TestCompositeResource\\TestCompositeResource.psd1″”.\u00a0 Sorry for the confusion!<\/span>\n<\/em><\/p>\n

\u00a0<\/em><\/p>\n

\n

PS C:\\> Get-DscResource -Name xVirtualMachine<\/span><\/p>\n

ImplementedAs\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Name\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Module\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Properties\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span><\/p>\n

————-\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 —-\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 ——\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 ———-\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0<\/span><\/p>\n

Composite\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 xVirtualMachine\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 TestCompositeResource\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 {VMName, SwitchName, SwitchType, VhdParentPath…}<\/span><\/p>\n

\n

Your configuration shows up as a composite resource<\/strong>.<\/span><\/p>\n

Let us now see how to use it:<\/span><\/p>\n

configuration<\/span> RenameVM<\/span><\/span><\/p>\n

{<\/span><\/p>\n

\n

Import-DscResource<\/span> -Module<\/span> TestCompositeResource<\/span><\/span><\/p>\n<\/blockquote>\n

\u00a0<\/span><\/p>\n

\n

Node localhost<\/span><\/span><\/p>\n<\/blockquote>\n

\n

{<\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0 xVirtualMachine VM<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0 {<\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 VMName =<\/span> “Test”<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 SwitchName =<\/span> “Internal”<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 SwitchType =<\/span> “Internal”<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 VhdParentPath =<\/span> “C:\\Demo\\Vhd\\RTM.vhd”<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 VHDPath =<\/span> “C:\\Demo\\Vhd”<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 VMStartupMemory =<\/span> 1024MB<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 VMState =<\/span> “Running”<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0 }<\/span><\/p>\n<\/blockquote>\n

\u00a0\u00a0\u00a0 }<\/span><\/p>\n

\u00a0\u00a0 <\/span>Node “192.168.10.1”<\/span><\/span><\/p>\n

\u00a0\u00a0 {<\/span>\u00a0\u00a0 <\/span><\/span><\/p>\n

\n

\u00a0\u00a0\u00a0 xComputer<\/span> Name<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0 {<\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 Name<\/span> =<\/span> “SQL01”<\/span><\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 DomainName<\/span> =<\/span> “fourthcoffee.com”<\/span> <\/span><\/p>\n<\/blockquote>\n

\n

\u00a0\u00a0\u00a0 }\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 <\/span><\/p>\n

}<\/span><\/p>\n<\/blockquote>\n

} <\/span><\/p>\n

\n

We have used the dynamic keyword Import-DscResource to make our composite resource type available in the configuration. The parameters of the composite resource become its properties. You can discover this in two ways, one way is to use the Get-DscResource cmdlet as above and the other is in ISE. I like the one in ISE since it does not require me to shift my focus to the command window and type in the cmdlet. You can take the cursor to the place where you have the name of the resource, and press CTRL+space. <\/strong> You can discover all the resources by using CTRL+Space after the configuration keyword as well. .You have to do it after Import-DscResource if importing custom resources.<\/span><\/p>\n

Here is what ISE displays:<\/span><\/p>\n

\"Image<\/a><\/p>\n

Tab completion works on the names of the properties just like any other resource, isn\u2019t that cool?<\/span><\/p>\n

This way, I have a configuration, where I reused one of my existing configurations and added one more resource to the overall configuration of my machine. This configuration first creates a VM and then uses the xComputerResource to rename it. I can thus build upon my existing configurations as and when the need arises for more complex configurations.<\/span><\/p>\n

\n

\n

\n

\n

Happy configuring!<\/span><\/p>\n

Abhik Chatterjee<\/span><\/p>\n

Windows PowerShell Developer<\/span><\/p>\n

\n

\n<\/div>\n","protected":false},"excerpt":{"rendered":"

You are an expert in PowerShell DSC (or maybe not an expert, just someone playing around with configurations in DSC) and have already written fairly large and complex configurations for configuring your environment\/data center. Everything is working well and you are a great fan of DSC. There\u2019s only one problem: your work is complicated. Before […]<\/p>\n","protected":false},"author":600,"featured_media":13641,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[142,150,251,345,348],"class_list":["post-1801","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-powershell","tag-desired-state-configuration","tag-dsc","tag-powershell-4-0","tag-windows-powershell-4-0","tag-windows-powershell-desired-state-configuration"],"acf":[],"blog_post_summary":"

You are an expert in PowerShell DSC (or maybe not an expert, just someone playing around with configurations in DSC) and have already written fairly large and complex configurations for configuring your environment\/data center. Everything is working well and you are a great fan of DSC. There\u2019s only one problem: your work is complicated. Before […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts\/1801","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/users\/600"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/comments?post=1801"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts\/1801\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/media\/13641"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/media?parent=1801"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/categories?post=1801"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/tags?post=1801"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}