Resource Type: dsc_xscript

Defined in:

lib/puppet/type/dsc_xscript.rb

Providers:

powershell

Overview

The DSC xScript resource type. Automatically generated from ‘xPSDesiredStateConfiguration/DSCResources/MSFT_xScriptResource/MSFT_xScriptResource.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

Parameters

• dsc_credential

  Credential - The credential of the user account to run the script under if needed.

• dsc_getscript

  GetScript - A string that can be used to create a PowerShell script block that retrieves the current state of the resource.

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_result

  Result - The result from the GetScript script block.

• dsc_setscript

  SetScript - A string that can be used to create a PowerShell script block that sets the resource to the desired state.

• dsc_testscript

  TestScript - A string that can be used to create a PowerShell script block that validates whether or not the resource is in the desired state.

• name (namevar)
• provider

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