Resource Type: dsc_xenvironment

Defined in:

lib/puppet/type/dsc_xenvironment.rb

Providers:

powershell

Overview

The DSC xEnvironment resource type. Automatically generated from ‘xPSDesiredStateConfiguration/DSCResources/MSFT_xEnvironmentResource/MSFT_xEnvironmentResource.schema.mof’

To learn more about PowerShell Desired State Configuration, please visit technet.microsoft.com/en-us/library/dn249912.aspx.

For more information about built-in DSC Resources, please visit technet.microsoft.com/en-us/library/dn249921.aspx.

For more information about xDsc Resources, please visit github.com/PowerShell/DscResources.

Properties

• ensure

  The basic property that the resource should be in.

  Supported values:

  • exists?
  • present
  • absent

Parameters

• dsc_ensure

  Ensure - Specifies if the environment varaible should exist. Valid values are Present, Absent.

• dsc_name

  Name - The name of the environment variable for which you want to ensure a specific state.

• dsc_path

  Path - Indicates whether or not the environment variable is the Path variable.

  Supported values:

  • true
  • false
• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_target

  Target - Indicates the target where the environment variable should be set. Valid values are Process, Machine.

• dsc_value

  Value - The desired value for the environment variable.

• name (namevar)
• provider

  The specific backend to use for this ‘dsc_xenvironment` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.