Add-StoragePluginHost

Short Description

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

Applies to

Platform: VMware

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

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

Syntax

This cmdlet provides parameter sets that allow you to:

  • Add storage systems by a username and password.

Add-StoragePluginHost -PluginType <string> -Name <string> -UserName <string> -Password <string> [-Description <string>] [-Proxy <IProxy[]>] [-MountServer <CHost>] [-Port <int>] [-SkipRescan] [-Force] [-iSCSI] [-FibreChannel] [-Nfs] [-AgentFC] [-AgentISCSI] [-AgentProxy <VBRNASProxyServer[]>] [-EnableVMwareBackup] [-EnableAgentBackup]  [<CommonParameters>]

  • Add storage systems by credentials.

Add-StoragePluginHost -PluginType <string> -Name <string> -Credentials <CInternalCredentials> [-Description <string>] [-Proxy <IProxy[]>] [-MountServer <CHost>] [-Port <int>] [-SkipRescan] [-Force] [-iSCSI] [-FibreChannel] [-Nfs] [-AgentFC] [-AgentISCSI] [-AgentProxy <VBRNASProxyServer[]>] [-EnableVMwareBackup] [-EnableAgentBackup]  [<CommonParameters>]

Detailed Description

This cmdlet adds selected Universal Storage API integrated systems to backup infrastructure.

When you add storage systems to your backup infrastructure, Veeam Backup & Replication performs a rescan of storage systems. During the rescan Veeam Backup & Replication retrieves information about the storage system topology and adds storage volumes to the backup infrastructure.

For more information about the rescan, see the Adding Storage Systems section of the User Guide for VMware vSphere.

Add-StoragePluginHost Tip:

Use the SkipRescan parameter to skip the automatic rescan.

To rescan storage systems manually, use the following cmdlets:

Parameters

Parameter

Description

Type

Required

Position

Accept
Pipeline
Input

PluginType

Specifies the storage Plug-in.

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

String

True

Named

False

Name

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

String

True

Named

False

UserName

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

String

True

Named

False

Password

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

String

True

Named

False

Credentials

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

Accepts the CInternalCredentials object. To create this object, run the Get-VBRCredentials cmdlet.

True

Named

False

Description

Specifies the description of the storage.

String

False

Named

False

MountServer

Specifies the mount server that you want to use to work with this storage.

Accepts the CHost object. To create this object, run the Get-VBRServer cmdlet.

False

Named

False

Port

Sets a port used to connect to the storage. By default, port 443 is used.

Int.

False

Named

False

SkipRescan

Defines that the cmdlet will not start the storage rescan automatically after you add storage systems to the backup infrastructure.

SwitchParameter

False

Named

False

Force

Defines that the cmdlet will add a ThinkSystem storage system without showing warnings in the PowerShell console.

SwitchParameter

False

Named

False

EnableVMwareBackup

Enables the VMware backup option.

If you provide this parameter, you will be able to use storage snapshots to backup and restore VMware vSphere VMs hosted on storage systems.

SwitchParameter

False

Named

False

EnableAgentBackup

Enables the Veeam Agent backup option.

Defines that the cmdlet will allow backup of Veeam Agents.

If you provide this parameter, you will be able to integrate your storage systems with Veeam Agent for Microsoft Windows installed on computers in your infrastructure.

SwitchParameter

False

Named

False

Proxy

For the EnableVMwareBackup parameter.

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

If set, Veeam Backup & Replication will use the selected proxies. If not set, Veeam Backup & Replication will use automatic proxy selection.

IProxy

False

Named

False

iSCSI

For the EnableVMwareBackup parameter.

Defines that the storage works over the iSCSI protocol.

SwitchParameter

False

Named

False

NFS

For the EnableVMwareBackup parameter.

Defines that the storage works over the NFS protocol.

SwitchParameter

False

Named

False

FibreChannel

For the EnableVMwareBackup parameter.

Defines that the storage works over the FibreChannel protocol.

SwitchParameter

False

Named

False

AgentFC

For the EnableAgentBackup parameter.

Defines that the storage works over the FS protocol.

SwitchParameter

False

Named

False

AgentISCSI

For the EnableAgentBackup parameter.

Defines that the storage works over the iSCSI protocol.

SwitchParameter

False

Named

False

AgentProxy

For the EnableAgentBackup parameter.

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

Accepts the VBRComputerFileProxyServer object. To create this object, run the Add-VBRComputerFileProxyServer cmdlet.

False

Named

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Examples

Adding IBM Spectrum Virtualize Storage System

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

Get-VBRStoragePlugin

Name                                    Version                                 Description

----                                    -------                                 -----------

IBM                                     0.1                                     Adds IBM SAN Volume Controller (SVC)...

InfiniBox                               1.0.6                                   Adds InfiniBox F-series system. Fibr...

FlashArray                              1.0.37.0                                Adds Pure Storage FlashArray. FC and...

$credentials = Get-VBRCredentials -Name "IBM Administrator"

$proxy = Get-VBRViProxy -Name 172.17.41.34

Add-StoragePluginHost -PluginType Ibm -Name 172.17.41.3 -Credentials $credentials -Description "IBM iSCSI" -Proxy $proxy

Perform the following steps:

  1. Run the Get-VBRStoragePlugin cmdlet. To add the IBM Spectrum Virtualize storage system to Veeam Backup & Replication, you will need the IBM Plug-in.
  2. Run the Get-VBRCredentials cmdlet. Specify the Name parameter value. Save the result to the $credentials variable.
  3. Run the Get-VBRViProxy cmdlet. Specify the Name parameter value. Save the result to the $proxy variable.
  4. Run the Add-StoragePluginHost cmdlet. Specify the following settings:
  • Set the Ibm option for the PluginType parameter value.
  • Specify the Name parameter value.
  • Set the $credentials variable as the Credentials parameter value.
  • Specify the Description parameter value.
  • Set the $proxy variable as the Proxy parameter value.

Related Commands