Add-StoragePluginHost - Veeam Backup PowerShell Reference
Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Add-StoragePluginHost

Short Description

Adds Universal Storage API integrated systems to Veeam Backup & Replication.

Applies to

Platform: VMware

Product Edition: Standard, Enterprise, Enterprise Plus

Storage System: IBM Spectrum Virtualize, INFINIDAT InfiniBox, Pure Storage, Huawei

Syntax

This cmdlet provides 2 parameter sets.

  • For authenticating with the storage using user name and password:

Add-StoragePluginHost -PluginType <String> -Name <String> -UserName <String> -Password <String> [-Description <String>] [-Proxy <IProxy[]>] [-iSCSI [<SwitchParameter>]] [-FibreChannel [<SwitchParameter>]] [-Nfs [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

  • For authenticating with the storage using credentials:

Add-StoragePluginHost -PluginType <String> -Name <String> -Credentials <CInternalCredentials> [-Description <String>] [-Proxy <IProxy[]>] [-iSCSI [<SwitchParameter>]] [-FibreChannel [<SwitchParameter>]] [-Nfs [<SwitchParameter>]] [-WhatIf [<SwitchParameter>]] [-Confirm [<SwitchParameter>]] [<CommonParameters>]

Detailed Description

This cmdlet adds Universal Storage API integrated systems to Veeam Backup & Replication. You will need to provide either user name/password or credentials. Use an appropriate parameter set for each case.

When you add a storage, Veeam Backup & Replication automatically rescans the storage infrastructure. To rescan the storage infrastructure manually, run Sync-StoragePluginHost or Sync-StoragePluginVolume.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

PluginType

Specifies the storage plug-in.

The cmdlet will use this plug-in for adding the associated storage to Veeam Backup & Replication.

True

Named

False

False

Name

Specifies the storage IP address or DNS name of the storage you want to add.

True

Named

False

False

UserName

Specifies the user name you want to use for authenticating with the storage.

True

Named

False

False

Password

Specifies the password you want to use for authenticating with the storage.

True

Named

False

False

Credentials

Specifies the credentials you want to use for authenticating with the storage.

True

Named

False

False

Description

Specifies the description of the storage.

False

Named

False

False

Proxy

Specifies the array of proxies you want to use to work with this storage.

If set, Veeam Backup & Replication will use the selected proxies. If not set, Veeam Backup & Replication will select a proxy automatically.

False

Named

False

False

iSCSI

Indicates that the storage works over iSCSI protocol.

False

Named

False

False

FibreChannel

Indicates that the storage works over FibreChannel protocol.

False

Named

False

False

NFS

Indicates that the storage works over NFS protocol.

False

Named

False

False

WhatIf

Specifies whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.

False

Named

False

False

Confirm

Specifies whether the cmdlet displays a prompt that asks if the user is sure that they want to continue.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Example

This example shows how to add IBM Spectrum Virtualize storage to Veeam Backup & Replication.

You will need to perform the following steps:

  1. Run Get-VBRStoragePlugin to get the list of installed storage plug-ins. To add the IBM Spectrum Virtualize storage system to Veeam Backup & Replication, you will need the IBM plug-in.
  2. Run Get-VBRCredentials to get the credentials record for the storage. Save the result to the $credentials variable.
  3. Run Get-VBRViProxy to get the backup proxy that will be used for storage rescan and Backup from Storage Snapshots. Save the result to the $proxy variable.
  4. Run Add-StoragePluginHost with the $credentials and $proxy variables.

PS C:\PS> Get-VBRStoragePlugin

Name                                    Version                                 Description
----                                    -------                                 -----------
IBM                                     0.1                                     Adds IBM SAN Volume Controller (SVC)...
Huawei                                  1.0.13.0                                Adds Huawei OceanStor Series storage...
InfiniBox                               1.0.6                                   Adds InfiniBox F-series system. Fibr...
FlashArray                              1.0.37.0                                Adds Pure Storage FlashArray. FC and...

PS C:\PS> $credentials = Get-VBRCredentials -Name "IBM Administrator"

PS C:\PS> $proxy = Get-VBRViProxy -Name 172.17.41.34

PS C:\PS> Add-StoragePluginHost -PluginType Ibm -Name 172.17.41.3 -Credentials $credentials -Description "IBM iSCSI" -Proxy $proxy

Related Commands

Get-VBRStoragePlugin

Get-VBRViProxy

Get-VBRCredentials

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Agent Management Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation