How to get Help information about Backup Exec Management Command Line Interface

Problem

How to get Help information about Backup Exec Management Command Line Interface (BEMCLI)

Solution

Help about the BEMCLI can be accessed by:

  • Go to the following path and run the help file  \Program Files\Symantec\Backup Exec\BEMCLI_en.chm
    This will open the help file in Windows help viewer.
  • While inside BEMCLI run the command  Show-BEHelp
    This will open the same help file mentioned above.

Command discovery

Get-BECommand can be used with wildcards to show a subset of available commands

example:

Get-BECommand *backup*

will show all commands the contatin the word backup

 

Getting cmdlet help

Get-help <cmdlet name>

this will give you a synopsis, the syntax, and description of the cmdlet

Get-help <cmdlet name> -Examples

This wil give you examples of how to use the cmdlet

BEMCLI> get-help New-BEBackupDefinition -Examples

NAME
    New-BEBackupDefinition

SYNOPSIS
    Creates a new backup definition in Backup Exec.

    -------------------------- EXAMPLE 1 --------------------------

    C:\PS> Get-BEAgentServer -Local | New-BEBackupDefinition -BackupJobDefault BackupToDisk | Save-BEBackupDefinition


    These commands create a new backup definition that backs up the entire local computer using the BackupToDisk defaults.
    -------------------------- EXAMPLE 2 --------------------------

    C:\PS> Get-BEAgentServer -Local | New-BEBackupDefinition -BackupJobDefault BackupToDisk -FileSystemSelection C:\Windows\*,D:\* -SystemStateSelection Include | Save-BEBackupDefinition


    These commands create a new backup definition that backs up the C:\Windows directory, the D: drive, and the System State of the local computer.
    -------------------------- EXAMPLE 3 --------------------------

    C:\PS> Get-BEAgentServer -Local | New-BEBackupDefinition -BackupJobDefault BackupToDisk | Remove-BEBackupTask * | Add-BEDifferentialBackupTask | Save-BEBackupDefinition


    These commands create a new backup definition that backs up the local computer with an initial full and a differential backup.
 

Other options for get-help are full, detailed, and parameter

 

 


Applies To

Backup Exec 2012 has a new Backup Exec Management Command Line Interface (BEMCLI) that replaces the Backup Exec Command Line Applet/Utility (BEMCMD) used in previous versions of Backup Exec (BE).

Terms of use for this information are found in Legal Notices.

Search

Survey

Did this article answer your question or resolve your issue?

No
Yes

Did this article save you the trouble of contacting technical support?

No
Yes

How can we make this article more helpful?

Email Address (Optional)