Resume PodeService

---

external help file: Pode-help.xml Module Name: Pode online version: PodeType: Service schema: 2.0.0

Resume-PodeService

SYNOPSIS

Resume a specified service on Windows systems.

SYNTAX

Default (Default)

Resume-PodeService -Name <String> [-Agent] [-ProgressAction <ActionPreference>] [<CommonParameters>]

Async

Resume-PodeService -Name <String> [-Async] [-Timeout <Int32>] [-Agent] [-ProgressAction <ActionPreference>]
 [<CommonParameters>]

DESCRIPTION

The `Resume-PodeService` function attempts to resume a specified service by name. This functionality is supported only on Windows systems using `sc.exe`. On Linux and macOS, the resume functionality for services is not natively available, and an appropriate error message is returned.

EXAMPLES

EXAMPLE 1

Resume-PodeService -Name 'MyService'

Resumes the service named 'MyService' if it is currently paused.

PARAMETERS

-Agent

Specifies that only agent-type services should be returned. This parameter is applicable to macOS only.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Async

Indicates whether to return immediately after issuing the resume command. If not specified, the function waits until the service reaches the 'Running' state.

Type: SwitchParameter
Parameter Sets: Async
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Name

The name of the service to resume.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Timeout

The maximum time, in seconds, to wait for the service to reach the 'Running' state when not using `-Async`. Defaults to 10 seconds.

Type: Int32
Parameter Sets: Async
Aliases:

Required: False
Position: Named
Default value: 10
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

System.Boolean

NOTES

• This function requires administrative/root privileges to execute.
• Platform-specific behavior:
  • Windows: Uses `sc.exe` with the `continue` argument.
  • Linux: Sends the `SIGCONT` signal to the service process.
  • macOS: Sends the `SIGCONT` signal to the service process.
• On Linux and macOS, an error is logged if the signal command fails or the functionality is unavailable.
• If the service is not paused, no action is taken.
• If the service is not registered, an error is thrown.

RELATED LINKS