Resource Type: dsc_xenvironment

Defined in:

lib/puppet/type/dsc_xenvironment.rb

Overview

The DSC xEnvironment resource type. Automatically generated from version 9.2.1

Properties

• dsc_ensure

  Specifies if the environment variable should exist.

• dsc_path

  Indicates whether or not the environment variable is a path variable. If the variable being configured is a path variable, the value provided will be appended to or removed from the existing value, otherwise the existing value will be replaced by the new value. When configured as a Path variable, multiple entries separated by semicolons are ensured to be either present or absent without affecting other Path entries.

• dsc_target

  Indicates the target where the environment variable should be set.

• dsc_value

  The desired value for the environment variable. The default value is an empty string which either indicates that the variable should be removed entirely or that the value does not matter when testing its existence. Multiple entries can be entered and separated by semicolons.

Parameters

• dsc_name (namevar)

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

• dsc_psdscrunascredential
• dsc_timeout

  The maximum time in seconds to wait for the DSC resource to complete.

• name (namevar)

  Description of the purpose for this resource declaration.

• validation_mode (defaults to: property)

  Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).