Data ONTAP® PowerShell Toolkit

Switch to clustered Data ONTAP documentation.

Cmdlet: Set-NaUser


NAME
Set-NaUser

SYNOPSIS
Modifies a user given the information provided.

SYNTAX
Set-NaUser [-User] <String> [-FullName <String>] [-Comment <String>] [-AddGr
oups <String[]>] [-RemoveGroups <String[]>] [-PasswordMinAge <Int64>] [-Pass
wordMaxAge <Int64>] [-Controller <NaController>] [<CommonParameters>]


DESCRIPTION
Modifies a user given the information provided.


PARAMETERS
-User <String>
User to modify.

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

-FullName <String>
Optional full name of user.

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

-Comment <String>
Optional comment for user.

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

-AddGroups <String[]>
List of groups to which to add this user.

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

-RemoveGroups <String[]>
List of groups from which to remove this user.

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

-PasswordMinAge <Int64>
Number of days that this user's password must be active before the user
can change it. Default value is 0.

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

-PasswordMaxAge <Int64>
Number of days that this user's password can be active before the user m
ust change it. Default value is 2^31-1 days.

Required? false
Position? named
Default value
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

<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.Types.Useradmin.UseradminUserInfo


NOTES


Category: useradmin
API: useradmin-user-modify

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

C:\PS>Set-NaUser SnapDriveUser -AddGroups VirtAdmins -RemoveGroups Administr
ators


Remove user 'SnapDriveUser' from the 'Administrators' group and add to the '
VirtAdmins' group.


Name : SnapDriveUser
FullName :
Comment :
UseradminGroups : {VirtAdmins}
AllowedCapabilities : {cli-cifs*, cli-exportfs*, cli-nfs*, cli-useradmin*..
.}
PasswordMaximumAgeTS : 10675199.02:48:05.4775807
PasswordMinimumAgeTS : 00:00:00
Rid : 131072
Status : enabled



RELATED LINKS
Get-NaUser
New-NaUser
Remove-NaUser







 Data ONTAP® PowerShell Toolkit