Backup Exec Management Command Line Interface Help
Stop-BEService Cmdlet
Synopsis

Stops one or more Backup Exec services.

Syntax
Stop-BEService [[-Name] [<String[]>]] [-PassThru [<SwitchParameter>]] [-ServiceType {Core | Deduplication}] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Stop-BEService -DisplayName [<String[]>] [-ServiceType {Core | Deduplication}] [-PassThru [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]
Description

Stops one or more Backup Exec services.

If you do not pass parameters to Stop-BEService, all of the core Backup Exec services are stopped.

Parameters

-PassThru <SwitchParameter>

Returns an object that represents the service. By default, this cmdlet does not generate any output.


Required false
Position Named
Accepts pipeline input false
Accepts wildcard characters false


-Name <String[]>

Specifies the name of the Backup Exec Service to stop.


Required false
Position 0
Accepts pipeline input true (ByValue ByPropertyName)
Accepts wildcard characters true


-DisplayName <String[]>

Specifies the common name of the Backup Exec service to restart.


Required true
Position Named
Accepts pipeline input false
Accepts wildcard characters false


-ServiceType

Specifies the Backup Exec service to stop.

The valid values are:
Core
Deduplication


Required false
Position Named
Accepts pipeline input false
Accepts wildcard characters false


-WhatIf <SwitchParameter>

Describes what happens if you execute the command without actually executing the command.


Required false
Position Named
Accepts pipeline input false
Accepts wildcard characters false


-Confirm <SwitchParameter>

Prompts you for confirmation before executing the command.


Required false
Position Named
Accepts pipeline input false
Accepts wildcard characters false


<CommonParameters>

For more information about common parameters, type "Get-Help about_commonparameters".

Input Type
System.String

You can pipe the name of the Backup Exec service to Stop-BEService.

Return Value
None or System.ServiceProcess.ServiceController

When you use the PassThru parameter, Stop-BEService generates a System.ServiceProcess.ServiceController object representing the service. Otherwise, this cmdlet does not generate any output.

Examples

Example 1

C:\PS> Stop-BEService

This command stops all of the Backup Exec core services.


Example 2
C:\PS> Stop-BEService -ServiceType Deduplication

This command stops all of the Backup Exec deduplication services.