< Back
Get-CServiceConfiguration
Post
NAME Get-CServiceConfiguration
SYNOPSIS
Gets a service's full configuration, e.g. username, path, failure actions, etc.
SYNTAX
Get-CServiceConfiguration [-Name] <String> [-ComputerName <String>] [<CommonParameters>]
DESCRIPTION
The .NET `ServiceController` object only returns basic information about a service. This function returns all the
other service configuration as a `Carbon.Service.ServiceInfo` object, which has the following properties:
* `DelayedAutoStart`: A boolean value indicating if the service starts automically delayed. This property was
added in Carbon 2.5.
* `Description`: The service's description.
* `ErrorControl`: A `Carbon.Service.ErrorControl` value that indicates the severity of the error when the service
fails to start.
* `FailureProgram`: The program to run when the service fails.
* `FirstFailure`: A `Carbon.Service.FailureAction` value indicating what will happen after the service's first
failure.
* `LoadOrderGroup`: The name of the load order group this service loads in.
* `Name`: The name of the service.
* `Path`: The path to the service executable (with arguments).
* `RebootDelay`: The number of milliseconds after boot to wait before the service starts.
* `RebootDelayMinutes`: `RebootDelay` expressed in minutes.
* `ResetPeriod`: How often, in seconds, to reset the service's failure count to 0.
* `ResetPeriodDays`: `ResetPeriod` expressed in number of days.
* `RestartDelay`: The number of milliseconds to wait before restarting the service after it fails.
* `RestartDelayMinutes`: `RestartDelay` expressed in minutes.
* `RunCommandDelay`: The number of milliseconds to wait after a service fails before running the failure program.
* `RunCommandDelayMinutes`: `RunCommandDelay` as expressed/converted in minutes.
* `SecondFailure`: A `Carbon.Service.FailureAction` value indicating what will happen after the service's second
failure.
* `StartType`: A `Carbon.Service.StartType` value indicating how and when the service should be started.
* `TagID`: The service's tag ID. This is the order the service will start in its load group.
* `ThirdFailure`: A `Carbon.Service.FailureAction` value indicating what will happen after the service's third
failure.
* `UserName`: The name of the identity the service runs as.
You can load a specific service using its name, or pipe in `ServiceController` objects.
In addition to this function, Carbon also adds this information as extended type data properties onto the
`ServiceController` class. To see it,
Get-Service | Get-Member
The user running this function must have `QueryConfig`, `QueryStatus`, and `EnumerateDependents` permissions on
the service. Use `Grant-CServicePermission` to grant these permissions.
This function is new in Carbon 1.8.
PARAMETERS
-Name <String>
The name of the service.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ComputerName <String>
The name of the computer where the service lives.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Carbon.Service.ServiceInfo
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-Service | Get-CServiceConfiguration
Demonstrates how you can pipe in a `ServiceController` object to load the service. This works for services on
remote computers as well.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-CServiceConfiguration -Name 'w3svc'
Demonstrates how you can get a specific service's configuration.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-CServiceConfiguration -Name 'w3svc' -ComputerName 'enterprise'
Demonstrates how to get service configuration for a service on a remote computer.
RELATED LINKS
Grant-CServicePermission
SYNOPSIS
Gets a service's full configuration, e.g. username, path, failure actions, etc.
SYNTAX
Get-CServiceConfiguration [-Name] <String> [-ComputerName <String>] [<CommonParameters>]
DESCRIPTION
The .NET `ServiceController` object only returns basic information about a service. This function returns all the
other service configuration as a `Carbon.Service.ServiceInfo` object, which has the following properties:
* `DelayedAutoStart`: A boolean value indicating if the service starts automically delayed. This property was
added in Carbon 2.5.
* `Description`: The service's description.
* `ErrorControl`: A `Carbon.Service.ErrorControl` value that indicates the severity of the error when the service
fails to start.
* `FailureProgram`: The program to run when the service fails.
* `FirstFailure`: A `Carbon.Service.FailureAction` value indicating what will happen after the service's first
failure.
* `LoadOrderGroup`: The name of the load order group this service loads in.
* `Name`: The name of the service.
* `Path`: The path to the service executable (with arguments).
* `RebootDelay`: The number of milliseconds after boot to wait before the service starts.
* `RebootDelayMinutes`: `RebootDelay` expressed in minutes.
* `ResetPeriod`: How often, in seconds, to reset the service's failure count to 0.
* `ResetPeriodDays`: `ResetPeriod` expressed in number of days.
* `RestartDelay`: The number of milliseconds to wait before restarting the service after it fails.
* `RestartDelayMinutes`: `RestartDelay` expressed in minutes.
* `RunCommandDelay`: The number of milliseconds to wait after a service fails before running the failure program.
* `RunCommandDelayMinutes`: `RunCommandDelay` as expressed/converted in minutes.
* `SecondFailure`: A `Carbon.Service.FailureAction` value indicating what will happen after the service's second
failure.
* `StartType`: A `Carbon.Service.StartType` value indicating how and when the service should be started.
* `TagID`: The service's tag ID. This is the order the service will start in its load group.
* `ThirdFailure`: A `Carbon.Service.FailureAction` value indicating what will happen after the service's third
failure.
* `UserName`: The name of the identity the service runs as.
You can load a specific service using its name, or pipe in `ServiceController` objects.
In addition to this function, Carbon also adds this information as extended type data properties onto the
`ServiceController` class. To see it,
Get-Service | Get-Member
The user running this function must have `QueryConfig`, `QueryStatus`, and `EnumerateDependents` permissions on
the service. Use `Grant-CServicePermission` to grant these permissions.
This function is new in Carbon 1.8.
PARAMETERS
-Name <String>
The name of the service.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-ComputerName <String>
The name of the computer where the service lives.
Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Carbon.Service.ServiceInfo
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-Service | Get-CServiceConfiguration
Demonstrates how you can pipe in a `ServiceController` object to load the service. This works for services on
remote computers as well.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-CServiceConfiguration -Name 'w3svc'
Demonstrates how you can get a specific service's configuration.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-CServiceConfiguration -Name 'w3svc' -ComputerName 'enterprise'
Demonstrates how to get service configuration for a service on a remote computer.
RELATED LINKS
Grant-CServicePermission