Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Remove-NcPortset


NAME
Remove-NcPortset

SYNOPSIS
Destroys an existing portset.

SYNTAX
Remove-NcPortset [-Name] <String> [-Force] [-VserverContext <String>] [-Cont
roller <NcController[]>] [<CommonParameters>]


DESCRIPTION
Destroys an existing portset. By default a set cannot be destroyed if there
are existing igroups associated with that portset.


PARAMETERS
-Name <String>
Name of the portset to destroy.

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

-Force
If not specified, the request will fail if there are any igroups bound t
o this portset. If specified, forcibly destroy the portset, even if the
re are existing igroup bindings. Best practice is to unbind all the ass
ociated igroups before destroying the portset.

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

-VserverContext <String>
Vserver to which to direct this command. If the currently connected con
troller (as embodied by an NcController object) represents a cluster, th
ere are multiple means to address commands to one of its vservers. Eith
er set the Vserver field on the NcController object to direct all subseq
uent commands to that vserver, or supply the VserverContext parameter to
an individual cmdlet. Only cmdlets which may be invoked on vservers of
fer the VserverContext parameter.

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

-Controller <NcController[]>
A clustered Data ONTAP controller to receive this cmdlet, as embodied by
an NcController object. This parameter is returned by the Connect-NcCo
ntroller cmdlet. If not specified, the value in the global variable Cur
rentNcController is used. In the latter case, if CurrentNcController co
ntains a collection of NcController objects, this cmdlet is invoked on e
ach controller in succession.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
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: portset
API: portset-destroy
Family: vserver

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

C:\PS>Remove-NcPortset portset_iscsi1


Destroy portset 'portset_iscsi1'.






RELATED LINKS
Get-NcPortset
New-NcPortset







 Data ONTAP® PowerShell Toolkit