DSC ServiceSet Resource

Applies To: Windows PowerShell 4.0, Windows PowerShell 5.x

The ServiceSet resource in Windows PowerShell Desired State Configuration (DSC) provides a mechanism to manage services on the target node. This resource is a composite resource that calls the Service resource for each service specified in the Name property.

Use this resource when you want to configure a number of services to the same state.

Note

This documentation of this DSC resource covers the version that's included with PowerShell prior to version 7.2. The PSDscResources module contains new and updated DSC Resources that are officially supported by Microsoft. The PSDscResources module is available from the PowerShell Gallery.

For more information and updated documentation, see the PSDscResources reference documentation.

Syntax

ServiceSet [string] #ResourceName
{
    Name = [string[]]
    [ StartupType = [string] { Automatic | Disabled | Manual }  ]
    [ BuiltInAccount = [string] { LocalService | LocalSystem | NetworkService }  ]
    [ State = [string] { Running | Stopped }  ]
    [ Credential = [PSCredential] ]
    [ DependsOn = [string[]] ]
    [ Ensure = [string] { Absent | Present }  ]
    [ PsDscRunAsCredential = [PSCredential] ]
}

Properties

Property	Description
Name	Indicates the service names. Note that sometimes this is different from the display names. You can get a list of the services and their current state with the Get-Service cmdlet.
StartupType	Indicates the startup type for the services. The values that are allowed for this property are: Automatic, Disabled, and Manual.
BuiltInAccount	Indicates the sign-in account to use for the services. The values that are allowed for this property are: LocalService, LocalSystem, and NetworkService.
State	Indicates the state you want to ensure for the services: Stopped or Running.
Credential	Indicates credentials for the account that the service resource will run under. This property and the BuiltinAccount property cannot be used together.

Common properties

Property	Description
DependsOn	Indicates that the configuration of another resource must run before this resource is configured. For example, if the ID of the resource configuration script block that you want to run first is ResourceName and its type is ResourceType, the syntax for using this property is DependsOn = "[ResourceType]ResourceName".
Ensure	Indicates whether the services exist on the system. Set this property to Absent to ensure that the services do not exist. Setting it to Present ensures that target services exist. The default value is Present.
PsDscRunAsCredential	Sets the credential for running the entire resource as.

Note

The PsDscRunAsCredential common property was added in WMF 5.0 to allow running any DSC resource in the context of other credentials. For more information, see Use Credentials with DSC Resources.

Example

The following configuration starts the "Windows Audio" and "Remote Desktop Services" services.

configuration ServiceSetTest
{
    Import-DscResource -ModuleName PSDesiredStateConfiguration

    Node localhost
    {
        ServiceSet ServiceSetExample
        {
            Name        = @("TermService", "Audiosrv")
            StartupType = "Manual"
            State       = "Running"
        }
    }
}