Skip to content

Latest commit

 

History

History
79 lines (55 loc) · 4.36 KB

VMware.vSphereDSC.md

File metadata and controls

79 lines (55 loc) · 4.36 KB
Raw

Getting Started

Requirements

VMware.vSphereDSC module contains Microsoft PowerShell Desired State Configuration Resources. The following table describes the required dependencies for running VMware.vSphereDSC Resources.

Required dependency Minimum version
PowerShell 5.1 or 7.0
PowerCLI 10.1.1

For information on how to install PowerShell, please visit Installing Windows PowerShell.

For information on how to install PowerCLI, please visit the PowerCLI Blog.

You also need to configure the DSC LCM on a Windows machine where the resources will run. For more information on how to configure it, please visit Desired State Configuration Quick Start

Installing the VMware.vSphereDSC Resources

There are two ways to install the VMware.vSphereDSC Module: Download it from the PowerShell Gallery or download it from the Releases page.

PowerShell Gallery

 Install-Module -Name VMware.vSphereDSC

Download it from Releases

  1. Copy the VMware.vSphereDSC Module to one of the system PowerShell module directories. For more information on installing PowerShell Modules, please visit Installing a PowerShell Module.

  2. In PowerShell import the VMware.vSphereDSC Module:

     Import-Module -Name 'VMware.vSphereDSC'

    To check if the module was successfully installed:

     Get-DscResource -Module 'VMware.vSphereDSC'

Applying VMware.vSphereDSC Resource Configuration

Configuring PowerCLI

To configure PowerCLI you can use the PowerCLISettings DSC Resource and specify which settings you want to be configured. For more information on the available settings, please visit the wiki page of the PowerCLISettings DSC Resource.

Documentation and Examples

Example

The following example uses VMHostNtpSettings Resource and configures the NTP Server and the 'ntpd' Service Policy.

  1. You need to compile the Configuration File to MOF: 
     $ntpConfigPath = Join-Path (Join-Path (Join-Path (Get-Module VMware.vSphereDSC -ListAvailable).ModuleBase 'Configurations') 'ESXiConfigs')'VMHostNtpSettings_Config.ps1'
 . $ntpConfigPath -Name '<VMHost Name>' -Server 'Server Name>' -User '<User Name>' -Password '<Password for User>'
  2. To Test if the NTP Settings are in the desired state: 
     Test-DscConfiguration -ComputerName <The name of the machine on which you are applying your configuration> -Path .\VMHostNtpSettings_Config\
  3. To Apply the NTP Configuration: 
     Start-DscConfiguration -ComputerName <The name of the machine on which you are applying your configuration> -Path .\VMHostNtpSettings_Config\ -Wait -Force
  4. To get the latest applied configuration on your machine: 
     Get-DscConfiguration

If you want to apply other configurations, you just need to compile the configuration file and pass the path of the created MOF file to the DSC cmdlets.

For more information about the DSC cmdlets please visit the PSDesiredStateConfiguration.

For a full list of resources in VMware.vSphereDSC and examples on their use, check out the Desired State Configuration Resources for VMware wiki.

Examples with Chef, Puppet and Ansible can be found here.