Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP Cluster-mode documentation.

Cmdlet: Remove-NaIgroup


NAME
Remove-NaIgroup

SYNOPSIS
Destroys an existing initiator group.

SYNTAX
Remove-NaIgroup [-Name] <String> [-Force] [-Controller <NaController>] [-Wha
tIf] [-Confirm] [<CommonParameters>]


DESCRIPTION
Destroys an existing initiator group. By default a group cannot be destroyed
if there are existing lun maps defined for that group. This behaviour can b
e overridden with the use of force option set to "true" which will destroy t
he initiator group and any associated lun maps.


PARAMETERS
-Name <String>
Name of initiator group.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false

-Force
Forcibly destroy the initiator group, even if there are existing lun map
s. Best practice is to attempt to unmap all the luns associated with a
group before destroying it.

Required? false
Position? named
Default value false
Accept pipeline input? false
Accept wildcard characters? false

-Controller <NaController>
The Data ONTAP controller object, embodied by an NaController object. T
his parameter is returned by the Connect-NaController cmdlet. If not sp
ecified, the value in the global variable CurrentNaController is used.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WhatIf


Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Confirm


Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS



NOTES


Category: igroup
API: igroup-destroy

-------------- Example 1 --------------

C:\PS>Remove-NaIgroup igroup4


Destroy igroup 'igroup4'.






RELATED LINKS
New-NaIgroup
Get-NaIgroup







 Data ONTAP® PowerShell Toolkit