Resource Type: dsc_xscript

Defined in:

lib/puppet/type/dsc_xscript.rb

Overview

The DSC xScript resource type. Automatically generated from version 9.2.1

Properties

• dsc_result

  The result from the GetScript script block.

Parameters

• dsc_credential

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

• dsc_getscript (namevar)

  A string that can be used to create a PowerShell script block that retrieves the current state of the resource. This script block runs when the Get-DscConfiguration cmdlet is called. This script block should return a hash table containing one key named Result with a string value.

• dsc_psdscrunascredential
• dsc_setscript (namevar)

  A string that can be used to create a PowerShell script block that sets the resource to the desired state. This script block runs conditionally when the Start-DscConfiguration cmdlet is called. The TestScript script block will run first. If the TestScript block returns False, this script block will run. If the TestScript block returns True, this script block will not run. This script block should not return.

• dsc_testscript (namevar)

  A string that can be used to create a PowerShell script block that validates whether or not the resource is in the desired state. This script block runs when the Start-DscConfiguration cmdlet is called or when the Test-DscConfiguration cmdlet is called. This script block should return a boolean with True meaning that the resource is in the desired state and False meaning that the resource is not in the desired state.

• 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).