Set-BEMedia Help

Synopsis

Sets the properties for a media in Backup Exec.

Syntax

Set-BEMedia -InputObject [<BEMedia[]>] [-Description [<String>]] [-Confirm [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [<CommonParameters>]

Description

Sets the properties for a media in Backup Exec.

Parameters

-Description <String>

Specifies the description for the media.

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

-InputObject <BEMedia[]>

Specifies one or more media objects. Enter a variable that contains the objects, or type a command or expression that gets the objects.

Required	true
Position	Named
Accepts pipeline input	true (ByValue)
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

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

Input Type

BackupExec.Management.CLI.BEMedia

You can pipe a Backup Exec media object to Set-BEMedia.

Return Value

BackupExec.Management.CLI.BEMedia

Set-BEMedia returns an object that represents the changed media.

Example

C:\PS> Get-BEMedia "Media 0001" | Set-BEMedia -Description "Test Media"

These commands add the description "Test Media" to a media named "Media 0001".