• Get-Carbon
• -Install
• -Documentation
• -Support
• -ReleaseNotes
• -Blog
• -Project

Carbon_Service

Syntax

Carbon_Service [String] #ResourceName
{
    Name = [string]
    [Command = [string]]
    [Credential = [PSCredential]]
    [Delayed = [bool]]
    [Dependency = [string[]]]
    [DependsOn = [string[]]]
    [Description = [string]]
    [DisplayName = [string]]
    [Ensure = [string]{ Absent | Present }]
    [OnFirstFailure = [string]{ Reboot | Restart | RunCommand | TakeNoAction }]
    [OnSecondFailure = [string]{ Reboot | Restart | RunCommand | TakeNoAction }]
    [OnThirdFailure = [string]{ Reboot | Restart | RunCommand | TakeNoAction }]
    [Path = [string]]
    [PsDscRunAsCredential = [PSCredential]]
    [RebootDelay = [Int32]]
    [ResetFailureCount = [Int32]]
    [RestartDelay = [Int32]]
    [RunCommandDelay = [Int32]]
    [StartupType = [string]{ Automatic | Disabled | Manual }]
    [UserName = [string]{ LocalService | LocalSystem | NetworkService }]
}

Description

Related Commands

• Grant-Privilege
• Install-Service
• Uninstall-Service

Parameters

EXAMPLE 1

Demonstrates how to install a service that runs as a custom account and has custom failure actions.

Carbon_Service InstallNoOpService
{
    Name = 'CarbonNoOpService';
    Path = 'C:\Projects\Carbon\bin\NoOpService.bin';
    StartupType = 'Automatic';
    Credential = $noOpServiceCreential';
    OnFirstFailure = 'RunCommand';
    Command = 'example.exe /fail %1%';
    RunCommandDelay = 1000;
    OnSecondFailure = 'Restart';
    RestartDelay = (1000*60*5); # 5 minutes as milliseconds
}

EXAMPLE 2

Demonstrates how to install a service that runs as a built-in account.

Carbon_Service InstallNoOpService
{
    Name = 'CarbonNoOpService';
    Path = 'C:\Projects\Carbon\bin\NoOpService.bin';
    StartupType = 'Automatic';
    UserName = 'LocalService';
}

EXAMPLE 3

Demonstrates how to remove a service.

Carbon_Service InstallNoOpService
{
    Name = 'CarbonNoOpService';
    Ensure = 'Absent';
}

EXAMPLE 4

Demonstrates how to set a service's start type Automatic (Delayed). This functionality was added in Carbon 2.5.

Carbon_Service InstallNoOpService
{
    Name = 'CarbonNoOpService';
    Path = 'C:\Projects\Carbon\bin\NoOpService.bin';
    StartupType = 'Automatic';
    Delayed = $true;
    Ensure = 'Present';
}