Stop a Pode-based service on Windows, Linux, or macOS.

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

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

The `Stop-PodeService` function ensures that a specified Pode-based service is stopped. If the service is not registered or fails to stop, the function throws an error. It supports platform-specific service management commands:

• Windows: Uses `sc.exe`.
• Linux: Uses `systemctl`.
• macOS: Uses `launchctl`.

Stop-PodeService -Name 'MyService'

Stops the service named 'MyService' if it is currently running.

Stop-PodeService -Name 'MyService' -Async

Stops the service named 'MyService' and returns immediately.

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

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

Type: SwitchParameter
Parameter Sets: Async
Aliases:

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

The name of the service to stop.

Type: String
Parameter Sets: (All)
Aliases:

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

{{ 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

The maximum time, in seconds, to wait for the service to reach the 'Stopped' 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

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

• This function checks for necessary administrative/root privileges before execution.
• Service state management behavior:
  • If the service is not running, no action is taken.
  • If the service is not registered, an error is thrown.
• Service name is retrieved from the `srvsettings.json` file if available.
• Platform-specific commands are invoked to manage service states:
  • Windows: `sc.exe`.
  • Linux: `sudo systemctl stop`.
  • macOS: `sudo launchctl stop`.
• Errors and logs are captured for debugging purposes.