Backup Exec Management Command Line Interface Help
Add-BESharePointFarmAgentServer Cmdlet
Synopsis

Adds a SharePoint Farm to Backup Exec.

Syntax
Add-BESharePointFarmAgentServer [-Name] [<String>] [-LogonAccount] [<BELogonAccount>] -WebServerName [<String>] [-Description [<String>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [-Force [<SwitchParameter>]] [<CommonParameters>]
Description

Adds a SharePoint Farm to Backup Exec.

Parameters

-WebServerName <String>

Specifies the name of a web server in the SharePoint Farm


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


-LogonAccount <BELogonAccount>

Specifies a Backup Exec logon account to use to access the servers in the SharePoint Farm.


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


-Description <String>

Specifies the description for the SharePoint Farm.


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


-Name <String>

Specifies the name of the SharePoint Farm.


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


-Force <SwitchParameter>

Confirms that Add-BESharePointFarmAgentServer can establish a trust with all servers in the SharePoint Farm.


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 a string that contains the name of the SharePoint Farm object to add to Add-BESharePointFarmAgentServer.

Return Value
BackupExec.Management.CLI.BESharePointFarmAgentServer

Add-BESharePointFarmAgentServer returns the SharePoint Farm agent server that was added.

Example
C:\PS> Add-BESharePointFarmAgentServer -Name Farm01 -WebServerName webserver01 -LogonAccount "System Logon Account"

This command adds the SharePoint Farm of which the web server named "webserver01" is a member.