Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Set-NcCifsLocalUser


NAME
Set-NcCifsLocalUser

SYNOPSIS
Modify a CIFS local user.

SYNTAX
Set-NcCifsLocalUser [-UserName] <String> [-FullName <String>] [-Description
<String>] [-IsAccountDisabled [<Boolean>]] [-VserverContext <String>] [-Cont
roller <NcController[]>] [<CommonParameters>]

Set-NcCifsLocalUser [-UserName] <String> [-Password] <SecureString> [-Vserve
rContext <String>] [-Controller <NcController[]>] [<CommonParameters>]


DESCRIPTION
Modify a CIFS local user.


PARAMETERS
-UserName <String>
The username of the CIFS local user.

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

-FullName <String>
The full name of the CIFS local user.

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

-Description <String>
The description of the CIFS local user.

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

-IsAccountDisabled [<Boolean>]
If true, disable the CIFS local user. If false, enable the CIFS local u
ser.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
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

-Password <SecureString>
New password to give the CIFS local user.

Required? true
Position? 2
Default value
Accept pipeline input? true (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
DataONTAP.C.Types.Cifs.CifsLocalUser


NOTES


Category: cifs
API: cifs-local-user-modify,cifs-local-user-set-password
Family: vserver

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

C:\PS>Set-NcCifsLocalUser bort -FullName 'Bort Samson'


Set the full name for user bort.


Description :
FullName : Bort Samson
IsAccountDisabled : False
NcController : 10.63.165.62
UserName : BEAM02\bort
Vserver : beam01
IsAccountDisabledSpecified : True


-------------- Example 2 --------------

C:\PS>Set-NcCifsLocalUser bort -Password (Read-Host "Password" -AsSecureStri
ng)


Change the password for the user bort by prompting for the new password on t
he console.


UserName Disabled Vserver Desc
ription
-------- -------- ------- ----
-------
BEAM02\bort False beam01


-------------- Example 3 --------------

C:\PS>Set-NcCifsLocalUser bort -Password (ConvertTo-SecureString "P@ssword12
3" -Force -AsPlainText)


Set the password for CIFS local user bort to the given plain text string.


UserName Disabled Vserver Desc
ription
-------- -------- ------- ----
-------
BEAM02\bort False beam01



RELATED LINKS
Get-NcCifsLocalUser
Rename-NcCifsLocalUser
Remove-NcCifsLocalUser
New-NcCifsLocalUser







 Data ONTAP® PowerShell Toolkit