Help Center
Choose product document...
Veeam Backup & Replication 9.5 Update 4
PowerShell Reference

Set-StoragePluginHost

Short Description

Modifies settings of Universal Storage API integrated systems.

Applies to

Platform: VMware

Product Edition: Standard, Enterprise, Enterprise Plus

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

Syntax

Set-StoragePluginHost -Host <CPublicPluginHost> [-Description <string>] [-UserName <string>] [-Password <string>][-Credentials <CInternalCredentials>] [-Proxy <IProxy[]>] [-Port <int>] [-VolumeScanType <VBRVolumeScanType> {All | Exclude | Include}] [-IncludedVolume <CSanInfrastructureVolume[]>] [-ExcludedVolume <CSanInfrastructureVolume[]>] [-EnableProxyAutoSelection] [-ProtocolPolicy <VBRStorageProtocolPolicy>] [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of Universal Storage API storage systems. When you modify storage system settings, the cmdlet automatically rescans storage systems.

To modify settings, enter the necessary parameters with new values. The parameters that you omit will remain unchanged.

Set-StoragePluginHost Tip:

You can specify the scope of volumes that you want to rescan with the VBRVolumeScanType parameter.

Run Get-StoragePluginInfrastructureVolume to get an array of volumes from Universal Storage API integrated systems.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Host

Specifies the storage you want to modify.

True

Named

True (ByValue,
ByProperty
Name)

False

Description

Specifies the description of the storage.

False

Named

False

False

UserName

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

False

Named

False

False

Password

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

False

Named

False

False

Credentials

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

False

Named

False

False

Proxy

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

NOTE: All previously used proxies will be unassigned from the storage.

If you want Veeam to choose a proxy for your storage automatically, use the EnableProxyAutoSelection parameter.

False

Named

False

False

EnableProxyAutoSelection

Indicates that Veeam Backup & Replication will select a proxy automatically.

If you want to select proxies for the storage yourself, use the Proxy parameter.

False

Named

False

False

ProtocolPolicy

Specifies the protocol policy for the storage.

Accepts the VBRStorageProtocolPolicy type.

False

Named

False

False

VolumeScanType

Specifies the scope of volumes that you want to rescan.

You can use the following options to rescan the volumes:

  • All - choose this option to scan all volumes that were added to your backup infrastructure with the initial scan.
  • Exclude - choose this option to exclude volumes from scan.
    NOTE: Veeam Backup & Replication will not show excluded volumes in the backup infrastructure after the rescan.
    Use the ExcludedVolume parameter to specify the excluded volumes.
  • Include - choose this option to scan only the specified storage volumes.
    Use the IncludedVolume parameter to specify the included volumes.

False

Named

False

 

IncludedVolume

For the VolumeScanType parameter with the Include option.

Specifies an array of storage volumes that you want to rescan.

NOTE: Veeam Backup & Replication will show only rescanned volumes in the backup infrastructure.

Accepts the CSanInfrastructureVolume type.

False

Named

False

 

ExcludedVolume

For the VolumeScanType parameter with the exclude option.

Specifies an array of storage volumes that you do not want to rescan.

NOTE: Veeam Backup & Replication will not show the excluded volumes in the backup infrastructure after the rescan.

Accepts the CSanInfrastructureVolume type.

False

Named

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 1

This example shows how to assign a new backup proxy to a storage system.

  1. Run Get-StoragePluginHost to get the storage system whose settings you want to modify. Save the result to the $storage variable.
  2. Run Get-VBRViProxy to get the backup proxy you want to assign. Save the result to the $proxy variable.
  3. Run Set-StoragePluginHost with the $storage and $proxy variables.

$storage = Get-StoragePluginHost -Name "IBM Spectrum"

$proxy = Get-VBRViProxy -Name "LocalProxy"

Set-StoragePluginHost -Host $storage -Proxy $proxy

Example 2

This example shows how to exclude volumes from of a Universal Storage API integrated system from rescan.

  1. Run Get-StoragePluginHost to get the storage system whose settings you want to modify. Save the result to the $storage variable.
  2. Run Get-StoragePluginInfrastructureVolume to get volumes that you do not want to rescan. Save the result to the $volumes variable.
  3. Run Set-StoragePluginHost with the $storage and $volumes variables.

$storage = Get-VNXHost -Name "VNX Storage"

$volumes = Get-StoragePluginInfrastructureVolume -Name "ISCSI Volume4", "ISCSI Volume5", "NFS Volume1"

Set-StoragePluginHost -Host $storage -VolumeScanType Exclude -ExcludedVolume $volumes

Example 3

This example shows how to rescan all volumes added to a Universal Storage API integrated system.

  1. Run Get-StoragePluginHost to get the storage system whose settings you want to modify. Save the result to the $storage variable.
  2. Run Get-StoragePluginInfrastructureVolume with the Host parameter to get volumes that you want to rescan. Save the result to the $volumes variable.
  3. Run Set-StoragePluginHost with the $storage and $volumes variables.

$storage = Get-VNXHost -Name "VNX Storage"

$volumes = Get-StoragePluginInfrastructureVolume -Host $storage

Set-StoragePluginHost -Host $storage -VolumeScanType Include -Included $volumes

Related Commands

Get-StoragePluginHost

Get-VBRViProxy

Get-VBRCredentials

New-VBRStorageProtocolPolicy

Get-StoragePluginInfrastructureVolume

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 Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation