Set-BEBackupExecServerPool Help

Synopsis

Sets the properties for a Backup Exec server pool.

Syntax

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

Description

Sets the properties for a Backup Exec server pool.

Parameters

-Description <String>

Specifies the description for the Backup Exec server pool.

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

-InputObject <BEBackupExecServerPool[]>

Specifies one or more Backup Exec server pool 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.BEBackupExecServerPool

You can pipe a Backup Exec server pool object to Set-BEBackupExecServerPool.

Return Value

BackupExec.Management.CLI.BEBackupExecServerPool

Set-BEBackupExecServerPool returns an object that represents the changed Backup Exec server pool.

Example

C:\PS> Get-BEBackupExecServerPool -Name "Server Pool 0001" | Set-BEBackupExecServerPool -Description "Test Pool"

These commands change the description of a Backup Exec server pool named "Server Pool 0001" to "Test Pool".