Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Lock-NcUser


NAME
Lock-NcUser

SYNOPSIS
Lock a user account that uses password as the authentication method.

SYNTAX
Lock-NcUser [-UserName] <String> -Vserver <String[]> [-Controller <NcControl
ler[]>] [-WhatIf] [-Confirm] [<CommonParameters>]


DESCRIPTION
Lock a user account that uses password as the authentication method. Return
s an error if the user account does not use password authentication.


PARAMETERS
-UserName <String>
Name of the user account to be locked.

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

-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
DataONTAP.C.Types.Security.SecurityLoginAccountInfo


NOTES


Category: security
API: security-login-lock
Family: cluster

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

C:\PS>Lock-NcUser rcuuser -Vserver dlamotta02


Lock user 'rcuuser' on vserver 'dlamotta02'.


UserName Application AuthMethod RoleName IsLocked Vserver
-------- ----------- ---------- -------- -------- -------
rcuuser http password rcu True dlamotta02
rcuuser ontapi password rcu True dlamotta02
rcuuser ssh password rcu True dlamotta02



RELATED LINKS
Get-NcUser
Unlock-NcUser







 Data ONTAP® PowerShell Toolkit