This is an archive version of the document. To get the most up-to-date information, see the current version.

Set-VNXHost

Short Description

Modifies Dell EMC VNX storage settings.

Applies to

Platform: VMware

Product Edition: Standard, Enterprise, Enterprise Plus

Storage System: Dell EMC VNX

Syntax

Set-VNXHost -Host <CVnxHost> [-Description <string>] [-UserName <string>] [-Password <string>] [-Credentials <CInternalCredentials>] [-CredentialsScope <VBRVNXBlockCredentialsScope> {Global | Local | LDAP}] [-Proxy <IProxy[]>] [-IncludedVolume <CSanInfrastructureVolume[]>]
[-ExcludedVolume <CSanInfrastructureVolume[]>][-IncludedWildcard <string[]>] [-ExcludedWildcard <string[]>][-EnableProxyAutoSelection] [-ProtocolPolicy <VBRStorageProtocolPolicy>] [-VolumeScanType <VBRVolumeScanType> {All| Exclude | Include}] [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet modifies settings of Dell EMC VNX 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-VNXHost Tip:

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

Run Get-VNXInfrastructureVolume to get an array of volumes from Dell EMC VNX storage systems.

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.

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

Credentials
Scope

Used to authenticate with the VNXBlock.

Specifies the credentials scope: Global, Local, LDAP.

False

Named

False

False

Proxy

Specifies the array of proxies you want to use.

False

Named

False

False

MountServer

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

False

Named

False

False

EnableProxyAutoSelection

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

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

 

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.

False

Named

False

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

 

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.

False

Named

False

True

WhatIf

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

False

Named

False

False

Confirm

Defines that the cmdlet will display the prompt that asks:

  • [For Dell EMC Unity/VNXe] If the user accepts the TLS certificate thumbprint installed on the Dell EMC server.
  • [For Dell EMC VNX file storage] If the user accepts the SSH key fingerprint of the Dell EMC server.

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 1

This example shows how to enable the automatic proxy selection for a Dell EMC VNX storage system.

  1. Run Get-VNXHost to get the storage system whose settings you want to modify. Save the result to the $storage variable.
  2. Run Set-VNXHost with the $storage variable. Use EnableProxyAutoSelection parameter for the automatic proxy selection.

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

Set-VNXHost -Host $storage -EnableProxyAutoSelection

Example 2

This example shows how to exclude Dell EMC VNX volumes from rescan.

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

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

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

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

Example 3

This example shows how to rescan all volumes added to a Dell EMC VNX storage system.

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

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

$volumes = Get-VNXInfrastructureVolume -Host $storage

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

Related Commands

Get-VBRCredentials

Get-VBRViProxy

Get-VNXInfrastructureVolume