Resource Type: dsc_xwindowsprocess

Defined in:

lib/puppet/type/dsc_xwindowsprocess.rb

Providers:

powershell

Overview

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

  Arguments - A string of arguments to pass to the process executable. Pass in an empty string if no arguments are needed.

• dsc_credential

  Credential - The credential to run the process under.

• dsc_ensure

  Ensure - Indicates whether the process is present (running) or absent (not running). Valid values are Present, Absent.

• dsc_handlecount

  HandleCount - The number of handles opened by the process.

• dsc_nonpagedmemorysize

  NonPagedMemorySize - The amount of nonpaged memory, in bytes, allocated for the process.

• dsc_pagedmemorysize

  PagedMemorySize - The amount of paged memory, in bytes, allocated for the process.

• dsc_path

  Path - The full path or file name to the process executable to start or stop.

• dsc_processcount

  ProcessCount - The number of instances of the given process that are currently running.

• dsc_processid

  ProcessId - The unique identifier of the process.

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_standarderrorpath

  StandardErrorPath - The path to write the standard error stream to.

• dsc_standardinputpath

  StandardInputPath - The path to receive standard input from.

• dsc_standardoutputpath

  StandardOutputPath - The path to write the standard output stream to.

• dsc_virtualmemorysize

  VirtualMemorySize - The amount of virtual memory, in bytes, allocated for the process.

• dsc_workingdirectory

  WorkingDirectory - The directory to run the processes under.

• name (namevar)
• provider

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