New-QADObject
From PowerGUI Wiki
Create a new object of 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
New-QADObject -ParentContainer <IdentityParameter> [-Name] <String> -Type <String> [-NamingProperty <String>] [-ObjectAttributes <ObjectAttributesParameter>] [-Description <String>] [-DisplayName <String>] [-ExcludedProperties <String[]>] [-IncludedProperties <String[]>] [-DeserializeValues] [-UseDefaultExcludedProperties [<Boolean>]] [-Proxy] [-UseGlobalCatalog] [-Service <String>] [-ConnectionAccount <String>] [-ConnectionPassword <SecureString>] [-Credential <PSCredential>] [-Connection <ArsConnection>] [-WhatIf] [-Confirm] [<CommonParameters>]
Detailed Description
Use this cmdlet to create a directory object of the specified schema class and a given name in the container. The cmdlet also allows for setting other properties (for example, the mandatory properties) on the new object.
The cmdlet can use the connection that is established by the Connect-QADService cmdlet.
The cmdlet has optional parameters that determine the server and the security context for the operation. Normally, the connection parameters could be omitted so far as 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.
Related Commands
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| ParentContainer | Specify the distinguished name (DN) of the container in which you want this cmdlet to create a new object. | true | true (ByPropertyName) | |
| Name | Specify the name for the new object to be created. | true | true (ByValue, ByPropertyName) | |
| Type | Specify the object class of the object to be created. This is the name of a schema class object, such as User or Group. The cmdlet creates a directory object of the object class specified by the value of this parameter. | true | false | |
| NamingProperty | Supply the LDAP name of the naming attribute specific to the object class of the object you want to create. The naming attribute qualifies the object's relative distinguished name. If this parameter is omitted, the naming attribute is assumed to be cn, which is suitable for most object classes. Other possible values are ou (naming attribute of the organizationalUnit object class) and dc (naming attribute of the domain object class). | false | false | |
| ObjectAttributes | Specify an associative array that defines the attributes to set. The array syntax:
@{attr1='val1';attr2='val2';...} In this syntax, each of the key-value pairs is the LDAP display name and the value of an attribute to set. Thus, passing the @{sAMAccountName='Amins'} array to the ObjectAttributes parameter causes the cmdlet to set the 'sAMAccountName' attribute to 'Admins'. For information about associative arrays, type the following command at the PowerShell command-prompt: help about_associative_array | false | true (ByValue, ByPropertyName) | |
| Description | Set the value of the 'description' attribute on the object to be created. | false | false | |
| DisplayName | Set the value of the 'displayName' attribute on the object to be created. | false | false | |
| ExcludedProperties | Use this parameter to specify the attributes that you do not want the cmdlet to update in the directory. Supply a list of the attribute LDAP display names as the parameter value. You could use this parameter when importing attribute values from a text file, in order to prevent some attributes found in the file from being set in the directory. | false | false | |
| IncludedProperties | Use this parameter to specify explicitly the attributes that you want the cmdlet to update in the directory. Supply a list of the attribute LDAP display names as the parameter value. When used together with UseDefaultExcludedProperties, this parameter allows you to have the cmdlet update some attributes that would not be updated otherwise.
Note: If a particular attribute is listed in both ExcludedProperties and IncludedProperties, the cmdlet does not set the value of that attribute the directory. | false | false | |
| DeserializeValues | Supply this parameter on the command line if the input you pass to the cmdlet contains serialized attribute values (for instance, when importing a directory object from a text file that was created using the Serialize parameter). For examples of how to export and import an object, see help on the Get-QADUser cmdlet. | false | false | |
| UseDefaultExcludedProperties | When set to 'true', this parameter causes the cmdlet not to update a certain pre-defined set of attributes in the directory. This pre-defined set of attributes (referred to as "default excluded properties") can be viewed or modified by using the Get-QADPSSnapinSettings or Set-QADPSSnapinSettings cmdlet, respectively. | false | false | false |
| Proxy | 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 | |
| Service | 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 | |
| Credential | For parameter description, see help on the Connect-QADService cmdlet. | false | false | |
| Connection | For parameter description, see help on the Connect-QADService cmdlet. | false | false | |
| WhatIf | Describes what would happen if you executed the command, without actually executing the command. | false | false | |
| Confirm | Prompts you for confirmation before executing the command. | false | false |
Examples
Example 1
new-qadObject -ParentContainer 'OU=ComputersOU,DC=company,DC=com' -type 'computer' -name 'comp1' -ObjectAttributes @{sAMAccountName='comp1'}
Connect to any available domain controller with the credentials of the locally logged on user, and create a new computer object.
Example 2
$pw = read-host "Enter password" -AsSecureString C:\PS>connect-qadService -service 'localhost' -proxy -ConnectionAccount 'company\administrator' -ConnectionPassword $pw C:\PS>new-qadObject -ParentContainer 'OU=companyOU,DC=company,DC=com' -type 'organizationalUnit' -NamingProperty 'ou' -name 'Child OU' C:\PS>disconnect-qadService
Connect to the local Administration Service with the credentials of a specific user, create a new organizational unit, and then disconnect.
Example 3
new-QADObject -Service 'server.domain.local:389' -ParentContainer '<DN of container>' -Type 'user' -Name 'John Smith'
Connect to the AD LDS instance on 'server.domain.local:389' with the credentials of the locally logged on user, and create a new AD LDS user object in a certain container.
