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, Veeam Universal License

Storage System: Dell EMC VNX

Syntax

Set-VNXHost -Host <CVnxHost> [-Description <string>] [-UserName <string>] [-Password <string>] [-Credentials <CInternalCredentials>] [-CredentialsScope {Global | Local | LDAP}] [-Proxy <IProxy[]>] [-MountServer <CHost>] [-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>] [-VolumeScanType {All | Exclude | Include}] [-AgentEnableProxyAutoSelection] [-AgentProtocolPolicy <VBRStorageProtocolPolicy>] [-EnableVMwareBackup] [-EnableAgentBackup] [<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	Type	Required	Position	Accept Pipeline Input
Host	Specifies the storage you want to modify.	Accepts the CVnxHost object. To create this object, run the Get-VNXHost cmdlet.	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	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
CredentialsScope	Used to authenticate with the VNXBlock. Specifies the credentials scope: Global, Local, LDAP.	VBRVNXBlockCredentialsScope	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.	String	False	Named	False
EnableProxyAutoSelection	For the EnableVMwareBackup parameter. Indicates that Veeam Backup & Replication will use automatic proxy selection.	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. Accepts the CSanInfrastructureVolume type.	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 Dell EMC VNX storage system without showing warnings in the PowerShell console.	SwitchParameter	False	Named	False

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 enable the automatic proxy selection for a Dell EMC VNX storage system.

Run Get-VNXHost to get the storage system whose settings you want to modify. Save the result to the $storage variable.
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.

Run Get-VNXHost to get the storage system whose settings you want to modify. Save the result to the $storage variable.
Run Get-VNXInfrastructureVolume to get volumes that you do not want to rescan. Save the result to the $volumes variable.
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.

Run Get-VNXHost to get the storage system whose settings you want to modify. Save the result to the $storage variable.
Run Get-VNXInfrastructureVolume with the Host parameter to get volumes that you want to rescan. Save the result to the $volumes variable.
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