Add-QADMemberOf
From PowerGUI Wiki
Make a particular object a member of particular groups in Active Directory. Supported are both Active Directory Domain Services (AD DS) and Active Directory Lightweight Directory Services (AD LDS).
This cmdlet is part of the Quest ActiveRoles Server product. Use Get-QARSProductInfo to view information about ActiveRoles Server.
Contents |
Syntax
Add-QADMemberOf [-Identity] <IdentityParameter> [-Group] <IdentityParameter[]> [-Connection <ArsConnection>] [-ConnectionAccount <string>] [-ConnectionPassword <SecureString>] [-Control <hashtable>] [-Credential <PSCredential>] [-Proxy] [-Replace] [-Service <string>] [-UseGlobalCatalog] [-Confirm] [-WhatIf] [<CommonParameters>]
Detailed Description
Use this cmdlet to add a single object to groups in Active Directory. You can specify a list of groups to which you want to add the object, separating the list entries by commas. The cmdlet also provides the option to remove the object from all groups other than those specified.
The cmdlet has optional parameters that determine the server and the security context for the operation. Normally, the connection parameters could be omitted since a connection to a server is established prior to using the cmdlet. In this case, the server and the security context are determined by the Connect-QADService cmdlet.
If you do not use Connect-QADService and have no connection established prior to using a cmdlet, then the connection settings, including the server and the security context, are determined by the connection parameters of the first cmdlet you use. Subsequent cmdlets will use those settings by default.
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| Connection | For parameter description, see help on the Connect-QADService cmdlet. | false | false | |
| ConnectionAccount | For parameter description, see help on the Connect-QADService cmdlet. | false | false | |
| ConnectionPassword | For parameter description, see help on the Connect-QADService cmdlet. | false | false | |
| Control | Use this parameter to pass request controls (in-controls) to ActiveRoles Server as part of an operation request. In ActiveRoles Server, request controls are used to send extra information along with an operation request, to control how ActiveRoles Server performs the request.
The parameter value is a hash table that defines the names and values of the request controls to be passed to ActiveRoles Server. The parameter syntax is as follows: -Control @{<name> = <value>; [<name> = <value>] ...}
In this syntax, each of the name-value pairs is the name and the value of a single control. For instructions on how to create and use hash tables, see topic "about_associative_array" or "about_hash_tables" in Windows PowerShell Help. For information about ActiveRoles Server request controls, refer to ActiveRoles Server SDK documentation. Note that this parameter only has an effect on the operations that are performed through ActiveRoles Server (connection established using the Proxy parameter); otherwise, this parameter causes an error condition in ActiveRoles Management Shell. | false | false | |
| Credential | For parameter description, see help on the Connect-QADService cmdlet. | false | false | |
| Group | Specify the DN, SID, GUID, or Domain\Name of the group or groups to which you want the cmdlet to add the object specified by the Identity parameter. | true | false | |
| Identity | Specify the DN, SID, GUID, or Domain\Name of the object whose group memberships you want the cmdlet to modify.
This parameter is optional since you can pipe into this cmdlet the object returned by a Get-QAD cmdlet. | true | true (ByValue) | |
| Proxy | For parameter description, see help on the Connect-QADService cmdlet. | false | false | |
| Replace | Supply this parameter on the command line if you want the cmdlet to remove the object specified by the Identity parameter from all groups except those specified by the Group parameter.
If this parameter is omitted, the cmdlet adds the object to the groups specified and retains the object in all groups in which the object already has membership. If this parameter is supplied, the cmdlet adds the object to the groups specified and removes the object from any other groups. | false | false | |
| Service | For parameter description, see help on the Connect-QADService cmdlet. | false | false | |
| UseGlobalCatalog | For parameter description, see help on the Connect-QADService cmdlet. | false | false | |
| Confirm | Prompts you for confirmation before executing the command. | false | false | |
| WhatIf | Describes what would happen if you executed the command without actually executing the command. | false | false |
Examples
EXAMPLE 1
Add-QADMemberOf 'domainName\userName' -Group 'domainName\groupName'
Description
Add a particular user to a particular group.
EXAMPLE 2
Add-QADMemberOf 'domainName\userName' -Group 'domainName\groupName' -Replace
Description
Add a particular user to a particular group and remove that user from the other groups.
