Set-StoragePluginHost

In this article

    Short Description

    Modifies settings of Universal Storage API integrated systems.

    Applies to

    Platform: VMware

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

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

    Syntax

    Set-StoragePluginHost -Host <CPublicPluginHost> [-Description <string>] [-UserName <string>] [-Password <string>] [-Credentials <CInternalCredentials>] [-Proxy <IProxy[]>] [-MountServer <CHost>] [-Port <int>] [-VolumeScanType {All | Exclude | Include}] [-IncludedVolume <CSanInfrastructureVolume[]>] [-ExcludedVolume <CSanInfrastructureVolume[]>] [-IncludedWildcard <string[]>] [-ExcludedWildcard <string[]>] [-AgentProxy <VBRNASProxyServer[]>] [-AgentVolumeScanType {All | Exclude | Include}] [-AgentIncludedVolume <CSanInfrastructureVolume[]>] [-AgentExcludedVolume <CSanInfrastructureVolume[]>] [-AgentIncludedWildcard <string[]>] [-AgentExcludedWildcard <string[]>] [-SkipRescan] [-Force] [-EnableProxyAutoSelection] [-ProtocolPolicy <VBRStorageProtocolPolicy>] [-AgentEnableProxyAutoSelection] [-AgentProtocolPolicy <VBRStorageProtocolPolicy>] [-EnableVMwareBackup] [-EnableAgentBackup]  [<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

    Type

    Required

    Position

    Accept
    Pipeline
    Input

    Host

    Specifies the storage you want to modify.

    CPublicPluginHost

    True

    Named

    True (ByValue,
    ByProperty
    Name)

    Description

    Specifies the description of the storage.

    String

    False

    Named

    False

    UserName

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

    String

    False

    Named

    False

    Password

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

    String

    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.

    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

    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.

    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 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.

    String

    False

    Named

    False

    EnableProxyAutoSelection

    For the EnableVMwareBackup parameter.

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

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

    SwitchParameter

    False

    Named

    False

    ProtocolPolicy

    For the EnableVMwareBackup parameter.

    Specifies the protocol policy for the storage.

    Accepts the VBRStorageProtocolPolicy object. To create this object, run the New-VBRStorageProtocolPolicy cmdlet.

    False

    Named

    False

    VolumeScanType

    For the EnableVMwareBackup parameter.

    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.

    VBRVolumeScanType

    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.

    CSanInfrastructureVolume

    False

    Named

    False

    IncludedWildcard

    For the VolumeScanType parameter with the include option.

    Specifies an array of storage volumes with wildcard characters. Veeam Backup & Replication will rescan only those volumes which names are specified with these wildcard characters.

    String

    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.

    CSanInfrastructureVolume

    False

    Named

    False

    ExcludedWildcard

    For the VolumeScanType parameter with the exclude option.

    Specifies an array of storage volumes with wildcard characters. Veeam Backup & Replication will not rescan the volumes which names are specified with these wildcard characters.

    String

    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

    AgentVolumeScanType

    For the EnableAgentBackup parameter.

    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.

    VBRVolumeScanType

    False

    Named

    False

    AgentIncludedVolume

    For the AgentVolumeScanType 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.

    CSanInfrastructureVolume

    False

    Named

    False

    AgentExcludedVolume

    For the AgentVolumeScanType 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.

    CSanInfrastructureVolume

    False

    Named

    False

    AgentIncludedWildcard

    For the AgentVolumeScanType parameter with the include option.

    Specifies an array of storage volumes with wildcard characters. Veeam Backup & Replication will rescan only those volumes which names are specified with these wildcard characters.

    String

    False

    Named

    False

    AgentExcludedWildcard

    For the AgentVolumeScanType parameter with the exclude option.

    Specifies an array of storage volumes with wildcard characters. Veeam Backup & Replication will not rescan the volumes which names are specified with these wildcard characters.

    String

    False

    Named

    False

    AgentEnableProxyAutoSelection

    For the EnableAgentBackup parameter.

    Indicates that Veeam Backup & Replication will use automatic proxy selection.

    SwitchParameter

    False

    Named

    False

    AgentProtocolPolicy

    For the EnableAgentBackup parameter.

    Specifies the protocol policy for the storage.

    Accepts the VBRStorageProtocolPolicy object. To create this object, run the New-VBRStorageProtocolPolicy cmdlet.

    False

    Named

    False

    SkipRescan

    Indicates 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 storage system without showing warnings in the PowerShell console.

    SwitchParameter

    False

    Named

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    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