Resource Type: dsc_xservice

Defined in:

lib/puppet/type/dsc_xservice.rb

Providers:

powershell

Overview

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

  BuiltInAccount - Indicates the sign-in account to use for the service. Valid values are LocalSystem, LocalService, NetworkService.

• dsc_credential

  Credential - The credential to run the service under.

• dsc_dependencies

  Dependencies - An array of strings indicating the names of the dependencies of the service.

• dsc_description

  Description - The description of the service.

• dsc_desktopinteract

  DesktopInteract - The service can create or communicate with a window on the desktop. Must be false for services not running as LocalSystem. Defaults to False.

  Supported values:

  • true
  • false
• dsc_displayname

  DisplayName - The display name of the service.

• dsc_ensure

  Ensure - Ensures that the service is present or absent. Defaults to Present. Valid values are Present, Absent.

• dsc_name

  Name - Indicates the service name. Note that sometimes this is different from the display name. You can get a list of the services and their current state with the Get-Service cmdlet.

• dsc_path

  Path - The path to the service executable file.

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_startuptimeout

  StartupTimeout - The time to wait for the service to start in milliseconds. Defaults to 30000.

• dsc_startuptype

  StartupType - Indicates the startup type for the service. Valid values are Automatic, Manual, Disabled.

• dsc_state

  State - Indicates the state you want to ensure for the service. Defaults to Running. Valid values are Running, Stopped, Ignore.

• dsc_terminatetimeout

  TerminateTimeout - The time to wait for the service to stop in milliseconds. Defaults to 30000.

• name (namevar)
• provider

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