Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP Cluster-mode documentation.

Cmdlet: Set-NaDomainUser


NAME
Set-NaDomainUser

SYNOPSIS
Adds or removes a nonlocal user to/from a group or groups.

SYNTAX
Set-NaDomainUser [-User] <String> [-AddGroups <String[]>] [-RemoveGroups <St
ring[]>] [-Controller <NaController>] [-WhatIf] [-Confirm] [<CommonParameter
s>]


DESCRIPTION
Adds or removes a nonlocal user to/from a group or groups. The user can be s
pecified as a SID or as domain\username. This API is only used in a windows
environment.


PARAMETERS
-User <String>
Name of the user in domain\username format. This can also be a SID (Wind
ows security identifier) describing a user. A SID has the format S-1-5-2
1-int-int-int-rid.

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

-AddGroups <String[]>
List of local groups to contain the domain user.

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

-RemoveGroups <String[]>
Remove the SID from this list of local groups.

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

-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: useradmin
API: useradmin-domainuser-add, useradmin-domainuser-delete

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

C:\PS>Set-NaDomainUser S-1-5-21-882373162-175273868-1218636855-131081 -Remov
eGroups Administrators


Remove the specified SID from the Administrators group.






RELATED LINKS
Get-NaDomainUser







 Data ONTAP® PowerShell Toolkit