|
|
Data ONTAP® PowerShell Toolkit
|
Cmdlet: Remove-NcUser
NAME
Remove-NcUser
SYNOPSIS
Delete an existing user account object.
SYNTAX
Remove-NcUser [-UserName] <String> -Vserver <String[]> -Application <String[
]> -AuthMethod <String> [-Controller <NcController[]>] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Delete an existing user account object.
PARAMETERS
-UserName <String>
Name of the user to be removed.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Vserver <String[]>
Vserver that owns the user account.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Application <String[]>
Name of the application. Possible values: 'console', 'http', 'ontapi',
'snmp', 'sp', 'ssh'.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-AuthMethod <String>
Authentication method for the application. Possible values: 'community'
, 'password', 'publickey', 'domain', 'nsswitch' and 'usm'.
Required? true
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
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
-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: security
API: security-login-delete
Family: cluster
-------------- Example 1 --------------
C:\PS>Get-NcUser vmware_admin | Remove-NcUser
Remove all instances of user 'vmware_admin', regardless of vserver, applicat
ion type, or authentication method.
RELATED LINKS
Get-NcUser
New-NcUser
Set-NcUser
| Copyright © 2012 NetApp. All rights reserved. Use is subject to license terms. |
|
Data ONTAP® PowerShell Toolkit
|