New-AdmOrganizationalUnit

Creates a new organizational unit.

Description

The New-AdmOrganizationalUnit cmdlet creates a new organizational unit (OU). You can set commonly used OU property values by using the cmdlet parameters. Property values that are not associated with cmdlet parameters can be set by using the OtherAttributes parameter.

You must set the Name parameter to create a new organizational unit. When you do not specify the Path parameter, the cmdlet creates an OU in the default NC head for the domain.

The following methods explain different ways to create an object by using this cmdlet:

Method 1: Use the New-AdmOrganizationalUnit cmdlet, specify the required parameters, and set any additional property values by using the cmdlet parameters.

Method 2: Use a template to create the new object. To do this, create a new organizational unit object or retrieve a copy of an existing OU object and set the Instance parameter to this object. The object provided to the Instance parameter is used as a template for the new object. You can override property values from the template by setting cmdlet parameters.

Method 3: Use the Import-CSV cmdlet to create custom objects from a comma-separated value (CSV) file that contains a list of object properties. Then pass the objects through the pipeline to the New-AdmOrganizationalUnit cmdlet to create the organizational unit objects.

Examples

Example 1 – Create an OU protected from accidental deletion 

New-AdmOrganizationalUnit -Name "UserAccounts" -Path "DC=FABRIKAM,DC=COM" -ProtectedFromAccidentalDeletion $true

This command creates an OU named UserAccounts that is protected from accidental deletion.

Example 2 – Create an OU and set properties 

New-AdmOrganizationalUnit -Name UserAccounts -Path "DC=FABRIKAM,DC=COM" -OtherAttributes @{seeAlso="CN=HumanResourceManagers,OU=Groups,OU=Managed,DC=Fabrikam,DC=com";managedBy="CN=TomC,DC=FABRIKAM,DC=COM"}

This command creates an OU named UserAccounts that is protected from accidental deletion. The seeAlso and managedBy properties are set to specified values.

Example 3 – Create an OU from a template 

$ouTemplate = Get-AdmOrganizationalUnit "OU=UserAccounts,DC=Fabrikam,DC=com" -properties seeAlso,managedBy 
New-AdmOrganizationalUnit -name TomCReports -instance $ouTemplate

This command creates a new OU from a template object.

Parameters

-AdaxesService

Specifies the DNS name of an Adaxes service that will be used to execute this cmdlet. If this parameter is not specified, and the cmdlet is running from an Adaxes Active Directory provider drive, the value for this parameter can be determined from the current path. For example, if the current path is Adaxes:/example.com, the Adaxes service on example.com will be used. If the parameter is not specified and the service DNS name can't be determined from the current path, the cmdlet will access Active Directory directly. To perform an operation in a Microsoft Entra managed domain, you must specify this parameter.

  • Type:

  • string

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

-City

Specifies a town or city of the organizational unit. This parameter sets the City property of the object. The schema name of the property is l.

  • Type:

  • string

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • True (ByPropertyName)

  • Accept wildcard characters:

  • False

-Confirm

Prompts you for confirmation before executing the command.

  • Type:

  • SwitchParameter

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • False

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

-Country

Specifies a country or region code of the organizational unit. This parameter sets the Country property of the object. The schema name of the property is c.

  • Type:

  • string

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • True (ByPropertyName)

  • Accept wildcard characters:

  • False

-Credential

Specifies the user account credentials to use to perform this task. The default credentials are the credentials of the currently logged on user unless the cmdlet is run from an Adaxes Active Directory PowerShell provider drive. If the cmdlet is run from such a provider drive, the account associated with the drive is the default one.

To specify this parameter, you can type a user name, such as User1 or Domain01\User01 or you can specify a PSCredential object. If you specify a user name for this parameter, the cmdlet prompts for a password.

You can also create a PSCredential object by using a script or by using the Get-Credential cmdlet. You can then set the Credential parameter to the PSCredential object.

If the acting credentials do not have permission to perform the task, the cmdlet returns a terminating error.

  • Type:

  • PSCredential

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

-Description

Specifies a description of the object. This parameter sets the Description property of the object. The schema name of the property is description.

  • Type:

  • string

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • True (ByPropertyName)

  • Accept wildcard characters:

  • False

-DisplayName

Specifies the display name of the object. This parameter sets the DisplayName property of the object. The schema name of the property is displayName.

  • Type:

  • string

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • True (ByPropertyName)

  • Accept wildcard characters:

  • False

-Instance

Specifies an instance of an organizational unit object to use as a template for a new OU object.

You can use an instance of an existing organizational unit object as a template or you can construct a new OU object by using the Windows PowerShell command line or by using a script. The following two methods describe how to create OU object templates:

Method 1: Use an existing organizational unit object as a template for a new object. To retrieve an instance of an existing OU object, use Get-AdmOrganizationalUnit. Then provide this object to the Instance parameter of the New-AdmOrganizationalUnit cmdlet to create a new OU object. You can override property values of the new object by setting the appropriate parameters.

Method 2: Create a new ADOrganizationalUnit object and set the property values by using the Windows PowerShell command line interface. Then pass this object to the Instance parameter of the New-AdmOrganizationalUnit cmdlet to create the new organizational unit object.

Note: Specified attributes are not validated, so attempting to set attributes that do not exist or cannot be set will raise an error.

  • Type:

  • ADOrganizationalUnit

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

-ManagedBy

Specifies the user or group that manages the organizational unit object. This parameter sets the ManagedBy (Primary) property of the object. The schema name of the property is managedby. This parameter is set by providing one of the following property values. The identifier in parentheses is the schema name of the property.

Possible values for this parameter are:

  • Distinguished name (distinguishedName)
  • GUID (objectGUID)
  • Security identifier (objectSid)
  • SAM Account Name (sAMAccountName)

  • Type:

  • Object

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • True (ByPropertyName)

  • Accept wildcard characters:

  • False

-ManagedByList

Specifies an array of users or groups that manage the organizational unit object. This parameter sets the Managed By property of the organizational unit. The schema name of the property is adm-ManagedBylist. This parameter is set by providing any of the following property values. The identifier in parentheses is the schema name of the property.

Possible values for this parameter are:

  • Distinguished name (distinguishedName)
  • GUID (objectGUID)
  • Security identifier (objectSid)
  • SAM Account Name (sAMAccountName)

You can use any combination of the above identifiers in an array to specify multiple owners. For example:

$owners = @(
    "CN=John Smith,CN=Users,DC=example,DC=com",
    "{75444639-7DAF-460F-AFAF-04CE891A4AF0}",
    "S-1-5-21-318736562-1752376529-4243903518-874036"
)
New-AdmOrganizationalUnit -Name "My OU" -ManagedByList $owners `
    -Path "DC=example,DC=com" -AdaxesService localhost

For more details on how object ownership works in Adaxes, see Object owners. If you specify this parameter, the AdaxesService parameter becomes required.

  • Type:

  • Object Array

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • True (ByPropertyName)

  • Accept wildcard characters:

  • False

-Name

Specifies the name of the object. This parameter sets the Name property of the new organizational unit. The schema name of the property is name.

The parameter becomes required in the following cases:

  • If there are no property patterns affecting the new organizational unit, that generate the value for their name property.
  • If you don't specify the properties required by the effective property pattern to generate name.
  • If the cmdlet is executed without the AdaxesService parameter.

  • Type:

  • string

  • Position:

  • 1

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • True (ByPropertyName)

  • Accept wildcard characters:

  • False

-OtherAttributes

Specifies values for attributes that are not represented by cmdlet parameters. You can set one or more values at the same time with this parameter. If an attribute takes more than one value, you can assign multiple values. To identify an attribute, specify its name exactly as it is defined in your directory schema.

To specify a single value for an attribute:

-OtherAttributes @{'AttributeName'=value}

To specify multiple values for an attribute:

-OtherAttributes @{'AttributeName'=value1,value2,...}

To specify values for multiple attributes:

-OtherAttributes @{'Attribute1Name'=value; 'Attribute2Name'=value1,value2;...}

  • Type:

  • Hashtable

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

  • Type:

  • SwitchParameter

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

-Path

Specifies the X.500 path of the organizational unit (OU) or container where the new object is created.

In many cases, a default value will be used for the Path parameter if no value is specified. The rules for determining the default value are given below. Note that rules listed first are evaluated first, and once a default value can be determined, no further rules will be evaluated.

A default value for Path will be set in the following cases:

  • If the cmdlet is run from an Adaxes Active Directory PowerShell provider drive, the parameter is set to the current path of the provider drive.
  • If the cmdlet has a default path, this will be used. For example: in New-AdmUser, the Path parameter would default to the Users container.
  • If none of the previous cases apply, the default value of Path will be set to the default partition or naming context of the target domain.

The Adaxes Active Directory provider cmdlets, such as New-Item parameter, Remove-Item parameter, Remove-ItemProperty parameter, Rename-Item parameter and Set-ItemProperty parameter, also contain a Path property. However, for the provider cmdlets, the Path parameter identifies the path of the actual object and not the container as with the Active Directory cmdlets.

  • Type:

  • string

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • True (ByPropertyName)

  • Accept wildcard characters:

  • False

-PostalCode

Specifies a postal code or zip code of the object. This parameter sets the PostalCode property of the object. The schema name of the property is postalCode.

  • Type:

  • string

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • True (ByPropertyName)

  • Accept wildcard characters:

  • False

-ProtectedFromAccidentalDeletion

Specifies whether to prevent the object from being deleted. When this property is set to $true, you cannot delete the corresponding object without changing the value of the property.

Possible values for this parameter are:

  • $false or 0
  • $true or 1

  • Type:

  • bool

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • True (ByPropertyName)

  • Accept wildcard characters:

  • False

-Server

Specifies the directory to connect to by providing one of the following values for a corresponding domain name or directory server. Specify the AD DS instance or the Microsoft Entra domain name in one of the following ways:

Domain name values:

  • Fully qualified domain name
  • NetBIOS name

Directory server values:

  • Fully qualified directory server name
  • NetBIOS name
  • Fully qualified directory server name and port

The default value for the Server parameter is determined by one of the following methods in the order that they are listed:

  • By using Server value from objects passed through the pipeline.
  • By using the server information associated with the Adaxes Active Directory PowerShell provider drive, when running under that drive.
  • By using the domain of the computer running PowerShell.

  • Type:

  • string

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

-State

Specifies a state or province of the object. This parameter sets the State property of the object. The schema name of the property is st.

  • Type:

  • string

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • True (ByPropertyName)

  • Accept wildcard characters:

  • False

-StreetAddress

Specifies a street address of the object. This parameter sets the StreetAddress property of the object. The schema name of the property is streetAddress.

  • Type:

  • string

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • True (ByPropertyName)

  • Accept wildcard characters:

  • False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

  • Type:

  • SwitchParameter

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

Inputs

None or Softerra.Adaxes.PowerShellModule.Directory.ADOrganizationalUnit

An organizational unit object that is a template for the new OU object is received by the Instance parameter.

Return Value

None or Softerra.Adaxes.PowerShellModule.Directory.ADOrganizationalUnit

Returns the new organizational unit object when the PassThru parameter is specified. By default, this cmdlet does not generate any output.

See also

© Softerra 2022. All rights reserved.
Send feedback