{"id":1881,"date":"2013-12-26T15:27:00","date_gmt":"2013-12-26T15:27:00","guid":{"rendered":"https:\/\/blogs.msdn.microsoft.com\/powershell\/2013\/12\/26\/holiday-gift-desired-state-configuration-dsc-resource-kit-wave-1\/"},"modified":"2019-02-18T13:05:25","modified_gmt":"2019-02-18T20:05:25","slug":"holiday-gift-desired-state-configuration-dsc-resource-kit-wave-1","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/powershell\/holiday-gift-desired-state-configuration-dsc-resource-kit-wave-1\/","title":{"rendered":"Holiday Gift \u2013 Desired State Configuration (DSC) Resource Kit Wave-1"},"content":{"rendered":"
\n

Continuing with the tradition of holiday gifts to the PowerShell community, the PowerShell team has just released DSC Resource Kit Wave-1 – a set of PowerShell modules that contain DSC resources and example configurations. The various modules that are part of DSC Resource Kit Wave 1 can be found <\/span>here<\/span><\/a>. <\/span><\/p>\n

<\/p>\n

When DSC was introduced in PowerShell v4, we shipped a <\/span>set of built-in resources<\/span><\/a>. However one of the important features of DSC is the ability to create custom resources in PowerShell. Our previous blog posts detail how to <\/span>author resources<\/span><\/a> and how to <\/span>deploy resources<\/span><\/a>. In order to encourage the community to create more DSC resources and help boot strap the authoring process, we are releasing this first wave. <\/span><\/p>\n

<\/p>\n

We have introduced a new naming convention for these modules and resources – they contain an “x” in them like xWebAdministration, MSFT_xWebsite, etc. The “x” stands for experimental – which means these resources are provided AS IS and are not supported through any Microsoft support program or service<\/strong>. We will monitor these, take feedback and may provide fixes on a “fix forward” basis – that is to say we may simply republish with fixes in future. I am deliberately using the word “may” to indicate no guarantees of any sort. However, you are free to adapt these to your environment and make changes as necessary. <\/span><\/p>\n

<\/p>\n

Description of Resources<\/span><\/strong><\/span><\/p>\n

<\/p>\n

To discover all the resources available as part of the resource kit, use the <\/span>Get-DSCResource<\/span><\/a> cmdlet:<\/span><\/p>\n

<\/p>\n

PS D:\\> Get-DscResource -Name x* | Format-Table Name, Module, ImplementedAs -AutoSize<\/span><\/p>\n

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

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

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

xComputer         xComputerManagement             PowerShell<\/span><\/p>\n

xVHD              xHyper-V                        PowerShell<\/span><\/p>\n

xVMHyperV         xHyper-V                        PowerShell<\/span><\/p>\n

xVMSwitch         xHyper-V                        PowerShell<\/span><\/p>\n

xDNSServerAddress xNetworking                     PowerShell<\/span><\/p>\n

xIPAddress        xNetworking                     PowerShell<\/span><\/p>\n

xDSCWebService    xPSDesiredStateConfiguration    PowerShell<\/span><\/p>\n

xWebsite          xWebAdministration              PowerShell <\/span><\/p>\n

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

Here is a brief description about each of the resource<\/span><\/p>\n

<\/p>\n\n\n\n\n\n\n\n\n\n\n\n
\n

Resource<\/span><\/strong><\/p>\n<\/td>\n

\n

Description<\/span><\/strong><\/p>\n<\/td>\n<\/tr>\n

\n

xComputer<\/span><\/p>\n<\/td>\n

\n

Name a computer and add it to a domain\/workgroup<\/span><\/p>\n<\/td>\n<\/tr>\n

\n

xVHD<\/span><\/p>\n<\/td>\n

\n

Create and managed VHDs<\/span><\/p>\n<\/td>\n<\/tr>\n

\n

xVMHyperV<\/span><\/p>\n<\/td>\n

\n

Create and manage a Hyper-V Virtual Machine<\/span><\/p>\n<\/td>\n<\/tr>\n

\n

xVMSwitch<\/span><\/p>\n<\/td>\n

\n

Create and manage a Hyper-V Virtual Switch<\/span><\/p>\n<\/td>\n<\/tr>\n

\n

xDNSServerAddress<\/span><\/p>\n<\/td>\n

\n

Bind a DNS Server address to one or more NIC<\/span><\/p>\n<\/td>\n<\/tr>\n

\n

xIPAddress<\/span><\/p>\n<\/td>\n

\n

Configure IPAddress (v4 and v6)<\/span><\/p>\n<\/td>\n<\/tr>\n

\n

xDSCWebService<\/span><\/p>\n<\/td>\n

\n

Configure DSC Service (aka Pull Server)<\/span><\/p>\n<\/td>\n<\/tr>\n

\n

xWebsite<\/span><\/p>\n<\/td>\n

\n

Deploy and configure a website on IIS<\/span><\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

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

 <\/span><\/strong><\/span><\/p>\n

 <\/span><\/strong><\/span><\/p>\n

Making Changes to Resources<\/span><\/strong><\/span><\/p>\n

 <\/p>\n

When making changes to these resources, we suggest the following practice:<\/span><\/p>\n

1.     <\/span><\/span>Update the following names by replacing MSFT with your company\/community name and replacing the “x” with “c” (short for “Community”) or another prefix of your choice:<\/span><\/p>\n

a.     <\/span><\/span>Module name (ex: xWebAdministration becomes cWebAdministration)<\/span><\/p>\n

a.     <\/span><\/span>Folder name (ex: MSFT_xWebsite becomes Contoso_cWebsite)<\/span><\/p>\n

b.     <\/span><\/span>Resource Name (ex: MSFT_xWebsite becomes Contoso_cWebsite)<\/span><\/p>\n

c.     <\/span><\/span>Resource Friendly Name (ex: xWebsite becomes cWebsite)<\/span><\/p>\n

d.     <\/span><\/span>MOF class name (ex: MSFT_xWebsite becomes Contoso_cWebsite)<\/span><\/p>\n

e.     <\/span><\/span>Filename for the <resource>.schema.mof (ex: MSFT_xWebsite.schema.mof becomes Contoso_cWebsite.schema.mof)<\/span><\/p>\n

2.     <\/span><\/span>Update module and metadata information in the module manifest<\/span><\/p>\n

3.     <\/span><\/span>Update any configuration that use these resources<\/span><\/p>\n

 <\/p>\n

We reserve resource and module names without prefixes (“x” or “c”) for future use (e.g. “MSFT_WebAdministration” or “Website”).  If the next version of Windows Server ships with a “Website” resource, we don’t want to break any configurations that use any community modifications.  Please keep a prefix such as “c” on all community modifications. <\/span><\/em><\/p>\n

 <\/p>\n

As specified in the license, you may copy or modify this resource as long as they are used on the Windows Platform. <\/span><\/em><\/p>\n

<\/p>\n

Requirements<\/span><\/strong><\/span><\/p>\n

<\/p>\n

The DSC Resource Kit requires Windows 8.1 or Windows Server 2012 R2 with update <\/span>KB2883200<\/span><\/a> (aka the GA Update Rollup). You can check whether it is installed by running the following command:<\/span><\/p>\n

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

PS C:\\WINDOWS\\system32> Get-HotFix -Id KB2883200<\/span><\/p>\n

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

Source        Description      HotFixID      InstalledBy          InstalledOn              <\/span><\/p>\n

——        ———–      ——–      ———–          ———–              <\/span><\/p>\n

NANA-TOUCH    Update           KB2883200     NANA-TOUCH\\Admini… 9\/30\/2013 12:00:00 AM    <\/span><\/p>\n

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

On supported down level operating systems, they require WMF 4.0. Refer to these previous blog posts for more information on <\/span>WMF 4.0<\/span><\/a> and <\/span>issues with partial installation<\/span><\/a>.<\/span><\/p>\n

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

Configurations using Resources from DSC Resource Kit<\/span><\/strong><\/span><\/p>\n

<\/p>\n

Once the resources are deployed, they can be used in configurations. An example configuration is given below (this example together with the sample website files are available as part of the examples of <\/span>xWebAdministration<\/span><\/a> module):<\/span><\/p>\n

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

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

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

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

        # Target nodes to apply the configuration<\/span><\/span><\/p>\n

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

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

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

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

        # Name of the website to create<\/span><\/span><\/p>\n

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

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

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

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

        # Source Path for Website content<\/span><\/span><\/p>\n

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

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

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

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

        # Destination path for Website content<\/span><\/span><\/p>\n

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

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

        [<\/span>String<\/span>]<\/span>$DestinationPath<\/span><\/span><\/p>\n

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

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

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

    Import-DscResource<\/span> -Module<\/span> xWebAdministration<\/span><\/span><\/p>\n

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

    Node $NodeName<\/span><\/span><\/p>\n

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

        # Install the IIS role<\/span><\/span><\/p>\n

        WindowsFeature IIS<\/span><\/span><\/p>\n

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

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

            Name            =<\/span> “Web-Server”<\/span><\/span><\/p>\n

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

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

        # Install the ASP .NET 4.5 role<\/span><\/span><\/p>\n

        WindowsFeature AspNet45<\/span><\/span><\/p>\n

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

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

            Name            =<\/span> “Web-Asp-Net45”<\/span><\/span><\/p>\n

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

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

        # Stop the default website<\/span><\/span><\/p>\n

        xWebsite DefaultSite<\/span> <\/span><\/p>\n

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

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

            Name            =<\/span> “Default Web Site”<\/span><\/span><\/p>\n

            State           =<\/span> “Stopped”<\/span><\/span><\/p>\n

            PhysicalPath    =<\/span> “C:\\inetpub\\wwwroot”<\/span><\/span><\/p>\n

            DependsOn       =<\/span> “[WindowsFeature]IIS”<\/span><\/span><\/p>\n

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

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

        # Copy the website content<\/span><\/span><\/p>\n

        File WebContent<\/span><\/span><\/p>\n

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

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

            SourcePath      =<\/span> $SourcePath<\/span><\/span><\/p>\n

            DestinationPath =<\/span> $DestinationPath<\/span><\/span><\/p>\n

            Recurse         =<\/span> $true<\/span><\/span><\/p>\n

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

            DependsOn       =<\/span> “[WindowsFeature]AspNet45”<\/span><\/span><\/p>\n

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

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

        # Create the new Website<\/span><\/span><\/p>\n

        xWebsite BakeryWebSite<\/span> <\/span><\/p>\n

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

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

            Name            =<\/span> $WebSiteName<\/span><\/span><\/p>\n

            State           =<\/span> “Started”<\/span><\/span><\/p>\n

            PhysicalPath    =<\/span> $DestinationPath<\/span><\/span><\/p>\n

            DependsOn       =<\/span> “[File]WebContent”<\/span><\/span><\/p>\n

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

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

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

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

# Create the MOF file using configuration parameters<\/span><\/p>\n

FourthCoffeeWebSite<\/span> -NodeName<\/span> “TestVM”<\/span> `<\/span><\/p>\n

                    -WebSiteName<\/span> “FourthCoffee”<\/span> -SourcePath<\/span> “C:\\BakeryWebsite\\”<\/span> -DestinationPath<\/span> “C:\\inetpub\\FourthCoffee”<\/span><\/span><\/p>\n

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

# Make it happen – Copy the MOF files to appropriate nodes and invoke the configuration<\/span><\/p>\n

Start-DscConfiguration<\/span> -Path<\/span>  “<\/span>$PSScriptRoot<\/span>\\FourthCoffeeWebsite”<\/span> -Wait<\/span> -Verbose<\/span> -Force<\/span> <\/span><\/p>\n

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

# Delete the MOF files<\/span><\/p>\n

del<\/span> -Path<\/span> “<\/span>$PSScriptRoot<\/span>\\FourthCoffeeWebsite”<\/span> -Recurse<\/span> -Verbose <\/span><\/span><\/p>\n

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

Note:<\/span><\/strong> Any resource that is not shipped as part of Windows, needs to be available in a module in PSModulePath and must be imported (using Import-DSCResource keyword) before it can be used in a configuration. <\/span><\/p>\n

Feel free to leave your feedback in the comments section as well as use the Q&A section in the <\/span>TechNet pages<\/span><\/a>. You can also provide feedback <\/span>here<\/span><\/a> in the connect page<\/span><\/p>\n<\/div>\n

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

Happy Holidays and a Happy new Year !!!<\/span><\/p>\n

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

Updated on 1\/2\/2014: Updated the renaming guidelines with examples<\/em><\/strong><\/span><\/p>\n

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

Narayanan (Nana) Lakshmanan<\/span><\/p>\n

Development Lead – PowerShell DSC<\/span><\/p>\n","protected":false},"excerpt":{"rendered":"

Continuing with the tradition of holiday gifts to the PowerShell community, the PowerShell team has just released DSC Resource Kit Wave-1 – a set of PowerShell modules that contain DSC resources and example configurations. The various modules that are part of DSC Resource Kit Wave 1 can be found here. When DSC was introduced in […]<\/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,152,153,195,248,251,290,345,348],"class_list":["post-1881","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-powershell","tag-desired-state-configuration","tag-dsc","tag-dsc-resource-kit","tag-dsc-resource-kit-wave-1","tag-holiday-gift","tag-powershell","tag-powershell-4-0","tag-resources","tag-windows-powershell-4-0","tag-windows-powershell-desired-state-configuration"],"acf":[],"blog_post_summary":"

Continuing with the tradition of holiday gifts to the PowerShell community, the PowerShell team has just released DSC Resource Kit Wave-1 – a set of PowerShell modules that contain DSC resources and example configurations. The various modules that are part of DSC Resource Kit Wave 1 can be found here. When DSC was introduced in […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts\/1881","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=1881"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts\/1881\/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=1881"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/categories?post=1881"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/tags?post=1881"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}