Add-StoragePluginHost

Short Description

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

Platform: VMware

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

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

Syntax

This cmdlet provides the following parameter sets:

AddCredentials

Add-StoragePluginHost -PluginType <String> -Name <String> [-Description <String>] -UserName <String>

-Password <String> [-Proxy <IProxy[]>] [-WindowsMountServer <CHost>] [-LinuxMountServer <CHost>]

[-Port <Int32>] [-SkipRescan] [-Force] [-iSCSI] [-FibreChannel] [-NVMe] [-Nfs] [-AgentFC] [-AgentISCSI]

[-AgentProxy <VBRComputerFileProxyServer[]>] [-ApplicationFC] [-ApplicationISCSI] [-EnableVMwareBackup]

[-EnableAgentBackup] [-EnableApplicationBackup] [<CommonParameters>]

Credentials

Add-StoragePluginHost -PluginType <String> -Name <String> [-Description <String>]

-Credentials <CInternalCredentials> [-Proxy <IProxy[]>] [-WindowsMountServer <CHost>]

[-LinuxMountServer <CHost>] [-Port <Int32>] [-SkipRescan] [-Force] [-iSCSI] [-FibreChannel] [-NVMe] [-Nfs]

[-AgentFC] [-AgentISCSI] [-AgentProxy <VBRComputerFileProxyServer[]>] [-ApplicationFC] [-ApplicationISCSI]

[-EnableVMwareBackup] [-EnableAgentBackup] [-EnableApplicationBackup] [<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.

Tip

Use the SkipRescan parameter to skip the automatic rescan.

To rescan storage systems manually, use the following cmdlets:

Run Sync-StoragePluginHost to rescan of the entire storage system.
Run Sync-StoragePluginVolume to rescan selected integrated systems volumes added to backup infrastructure.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
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.	`VBRComputerFileProxyServer[]`	False	Named	False
ApplicationFC	For the `EnableApplicationBackup` parameter. Defines that the storage works over the FibreChannel protocol.	`SwitchParameter`	False	Named	False
ApplicationISCSI	For the `EnableApplicationBackup` parameter. Defines that the storage works over the iSCSI protocol.	`SwitchParameter`	False	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.	`CInternalCredentials`	True	Named	False
Description	Specifies the description of the storage.	`String`	False	Named	False
EnableAgentBackup	Defines that Veeam Backup & Replication 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
EnableApplicationBackup	Defines that Veeam Backup & Replication will allow backup of InterSystems IRIS instances. If you provide this parameter, you will be able to use storage snapshots to back up and restore data of InterSystems IRIS instances hosted on storage systems.	`SwitchParameter`	False	Named	False
EnableVMwareBackup	Defines that Veeam Backup & Replication will allow backup of VMware VMs. 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
FibreChannel	For the `EnableVMwareBackup` parameter. Defines that the storage works over the FibreChannel protocol.	`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
iSCSI	For the `EnableVMwareBackup` parameter. Defines that the storage works over the iSCSI protocol.	`SwitchParameter`	False	Named	False
LinuxMountServer	Specifies Linux mount server. The storage systems will use this mount server for file-level and application items restore.	`CHost`	False	Named	False
Name	Specifies the storage IP address or DNS name of the storage you want to add.	`String`	True	Named	False
Nfs	For the `EnableVMwareBackup` parameter. Defines that the storage works over the NFS protocol.	`SwitchParameter`	False	Named	False
NVMe	For the `EnableVMwareBackup` parameter. Defines that the storage works over the NVMe protocol.	`SwitchParameter`	False	Named	False
Password	Specifies the password you want to use for authenticating with the storage.	`String`	True	Named	False
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
Port	Sets a port used to connect to the storage. By default, port 443 is used.	`Int32`	False	Named	False
Proxy	For the `EnableVMwareBackup` parameter. Specifies an array of proxies you want to use with this storage. If not set, Veeam Backup & Replication will use automatic proxy selection. Accepts the `IProxy[]` object. To create this object, run the `Get-VBRViProxy` cmdlet.	`IProxy[]`	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
UserName	Specifies the user name that you want to use for authenticating with the storage.	`String`	True	Named	False
WindowsMountServer	Specifies Windows mount server. The storage systems will use this mount server for file-level and application items restore.	`CHost`	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

$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:

Run the Get-VBRStoragePlugin cmdlet. To add the IBM Spectrum Virtualize storage system to Veeam Backup & Replication, you will need the IBM Plug-in.
Run the Get-VBRCredentials cmdlet. Specify the Name parameter value. Save the result to the $credentials variable.
Run the Get-VBRViProxy cmdlet. Specify the Name parameter value. Save the result to the $proxy variable.
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.