Remove-VolumeMapping

SYNOPSIS

Removes a mapping between a volume and a host or host group on the PowerStore cluster.

SYNTAX

ByVolumeNameHostName (Default)

Remove-VolumeMapping [-Cluster] <Cluster> -VolumeName <String> -HostName <String> [-Confirm] [-Force] [-PassThru] [-WhatIf] [<CommonParameters>]

ByVolumeNameHostId

Remove-VolumeMapping [-Cluster] <Cluster> -VolumeName <String> -HostId <String> [-Confirm] [-Force] [-PassThru] [-WhatIf] [<CommonParameters>]

ByVolumeNameHostGroupName

Remove-VolumeMapping [-Cluster] <Cluster> -VolumeName <String> -HostGroupName <String> [-Confirm] [-Force] [-PassThru] [-WhatIf] [<CommonParameters>]

ByVolumeNameHostGroupId

Remove-VolumeMapping [-Cluster] <Cluster> -VolumeName <String> -HostGroupId <String> [-Confirm] [-Force] [-PassThru] [-WhatIf] [<CommonParameters>]

ByVolumeIdHostName

Remove-VolumeMapping [-Cluster] <Cluster> -VolumeId <String> -HostName <String> [-Confirm] [-Force] [-PassThru] [-WhatIf] [<CommonParameters>]

ByVolumeIdHostId

Remove-VolumeMapping [-Cluster] <Cluster> -VolumeId <String> -HostId <String> [-Confirm] [-Force] [-PassThru] [-WhatIf] [<CommonParameters>]

ByVolumeIdHostGroupName

Remove-VolumeMapping [-Cluster] <Cluster> -VolumeId <String> -HostGroupName <String> [-Confirm] [-Force] [-PassThru] [-WhatIf] [<CommonParameters>]

ByVolumeIdHostGroupId

Remove-VolumeMapping [-Cluster] <Cluster> -VolumeId <String> -HostGroupId <String> [-Confirm] [-Force] [-PassThru] [-WhatIf] [<CommonParameters>]

ById

Remove-VolumeMapping [-Cluster] <Cluster> -Id <String[]> [-Confirm] [-Force] [-PassThru] [-WhatIf] [<CommonParameters>]

DESCRIPTION

Removes a mapping between a volume and a host or host group on the PowerStore cluster.

EXAMPLES

Example 1

PS C:\> Remove-VolumeMapping -Cluster $cluster -id id1,id2

Where $cluster is a PowerStore cluster instance. Removes the volume mappings with Ids id1 and id2.

Example 2

PS C:\> Remove-VolumeMapping -Cluster $cluster -VolumeId vid1 -HostId hid1

Where $cluster is a PowerStore cluster instance. Removes a mapping between volume with Id vid1 and host with Id hid1.

Example 3

PS C:\> Remove-VolumeMapping -Cluster $cluster -VolumeName volume1 -HostName host1

Where $cluster is a PowerStore cluster instance. Removes a mapping between volume volume1 and host host1.

Example 4

PS C:\> Remove-VolumeMapping -Cluster $cluster -VolumeName volume1 -HostGroupName hostgroup1

Where $cluster is a PowerStore cluster instance. Removes a mapping between volume volume1 and host group hostgroup1.

PARAMETERS

-Cluster

A PowerStore cluster instance.

Type: Cluster
Parameter Sets: (All)
Aliases:

Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-VolumeName

Volume name.

Type: String
Parameter Sets: ByVolumeNameHostId, ByVolumeNameHostName, ByVolumeNameHostGroupId, ByVolumeNameHostGroupName
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-VolumeId

Volume Id.

Type: String
Parameter Sets: ByVolumeIdHostId, ByVolumeIdHostName, ByVolumeIdHostGroupId, ByVolumeIdHostGroupName
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-HostName

Host name.

Type: String
Parameter Sets: ByVolumeIdHostName, ByVolumeNameHostName
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-HostId

Host Id.

Type: String
Parameter Sets: ByVolumeIdHostId, ByVolumeNameHostId
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-HostGroupName

Host group name.

Type: String
Parameter Sets: ByVolumeIdHostGroupName, ByVolumeNameHostGroupName
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-HostGroupId

Host group Id.

Type: String
Parameter Sets: ByVolumeIdHostGroupId, ByVolumeNameHostGroupId
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Id

Volume mapping Id.

Type: String[]
Parameter Sets: ById
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Force

Suppress confirmation prompt before removing volume mapping.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PassThru

Return removed volume mapping instance.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

None

OUTPUTS

Dell.PowerStore.Management.Model.HostVolumeMapping

NOTES