Set-AdmObject

Modifies a directory object.

Description

The Set-AdmObject cmdlet modifies the properties of a directory object. You can modify commonly used property values by using the cmdlet parameters. Property values that are not associated with cmdlet parameters can be modified by using the Add, Remove, Replace, and Clear parameters.

The Identity parameter specifies the directory object to modify. You can identify an object by its distinguished name or GUID. You can also set the Identity parameter to an object variable such as $<localObject>, or you can pass an object through the pipeline to the Identity parameter. For example, you can use the Get-AdmObject cmdlet to retrieve an object and then pass the object through the pipeline to the Set-AdmObject cmdlet.

The Instance parameter provides a way to update an object by applying the changes made to a copy of the object. When you set the Instance parameter to a copy of a directory object that was modified, the Set-AdmObject cmdlet makes the same changes to the original object. To get a copy of the object to modify, use the Get-AdmObject cmdlet. The Identity parameter is not allowed when you use the Instance parameter.

Examples

Example 1 – Set description for an object identified by distinguished name 

Set-AdmObject 'CN=AntonioAl Direct Reports,OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM' -Description 'Distribution List of Antonio Alwan Direct Reports'

This command sets the Description property for the object with distinguished name CN=AntonioAl Direct Reports,OU=Finance,OU=UserAccounts,DC=FABRIKAM,DC=COM to Distribution List of Antonio Alwan Direct Reports.

Example 2 – Add a site to a property of an object 

Set-AdmObject 'CN=DEFAULTIPSITELINK,CN=IP,CN=Inter-Site Transports,CN=Sites,CN=Configuration,DC=FABRIKAM,DC=COM' -Add @{siteList='CN=BO3,CN=Sites,CN=Configuration,DC=FABRIKAM,DC=COM'} -Partition 'CN=Configuration,DC=FABRIKAM,DC=COM'

This command adds site CN=BO3,CN=Sites,CN=Configuration,DC=FABRIKAM,DC=COM to the property siteList on the object with distinguished name CN=DEFAULTIPSITELINK,CN=IP,CN=Inter-Site Transports,CN=Sites,CN=Configuration,DC=FABRIKAM,DC=COM.

Example 3 – Add URLs to an object property 

$urlValues = @()
$urlValues += "www.contoso.com"
$urlValues += "www.fabrikam.com"

Set-AdmObject "cdadd380-d3a8-4fd1-9d30-5cf72d94a056" -Add @{url=$urlValues}

This command adds two new values to the url property of the object with GUID cdadd380-d3a8-4fd1-9d30-5cf72d94a056.

Example 4 – Set values for a multi-valued property 

$urlValues = @()
$urlValues += "www.contoso.com"
$urlValues += "www.fabrikam.com"

Set-AdmObject "cdadd380-d3a8-4fd1-9d30-5cf72d94a056" -Replace @{url=$urlValues;description="Antonio Alwan"}

This command replaces the old values of the multivalued url property with new values and sets the value of the Description property to Antonio Alwan.

Example 5 – Remove a value from an object property 

Set-AdmObject "cdadd380-d3a8-4fd1-9d30-5cf72d94a056" -Remove @{url="www.contoso.com"} -Replace @{description="Antonio Alwan (European Manager)"}

This command removes the specified value from the url property and sets the value of the Description property to Antonio Alwan (European Manager).

Example 6 – Set a UAC bit on an object 

$myComp = Get-AdmObject -identity "cdadd380-d3a8-4fd1-9d30-5cf72d94a056" -Properties "userAccountControl","description"
$myComp.userAccountControl = $myComp.userAccountControl -bor 50
$myComp.description = "Setting a new UAC on the object"
Set-AdmObject -Instance $myComp

This command sets a new User Access Control (UAC) bit on an object by updating the userAccountControl property, and sets the value of the description property to Setting a new UAC on the 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

-Add

Specifies values to add to an object property. Use this parameter to add one or more values to a property that cannot be modified using a cmdlet parameter. To modify an object property, use its schema name. You can specify multiple values to a property by specifying a comma-separated list of values, and more than one property by separating them using a semicolon. The format for the parameter is:

-Add @{Attribute1Name=value1, value2, ...; Attribute2Name=value1, value2, ...; AttributeXName=value1, value2, ...}

When you use the Add, Remove, Replace, and Clear parameters together, the operations will be performed in the following order:

  • Remove
  • Add
  • Replace
  • Clear

  • Type:

  • Hashtable

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

-Clear

Specifies an array of object properties that will be cleared. Use this parameter to clear one or more values of a property that cannot be modified using a cmdlet parameter. To modify an object property, use its schema name. You can modify more than one property by specifying a comma-separated list. The format for this parameter is:

-Clear @(Attribute1Name, Attribute2Name)

When you use the Add, Remove, Replace, and Clear parameters together, the operations will be performed in the following order:

  • Remove
  • Add
  • Replace
  • Clear

  • Type:

  • string[]

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • 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

-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 value of 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:

  • False

  • 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:

  • False

  • Accept wildcard characters:

  • False

-Identity

Specifies a directory object by providing one of the following property values. The identifier in parentheses is the schema name of the attribute.

Possible values for this parameter are:

  • Distinguished name (distinguishedName)
  • GUID (objectGUID)

The cmdlet searches the default naming context or partition to find the object.

This parameter can also get this object through the pipeline or you can set this parameter to an object instance.

Derived types, such as the following are also accepted:

  • Softerra.Adaxes.PowerShellModule.Directory.ADGroup
  • Softerra.Adaxes.PowerShellModule.Directory.ADUser
  • Softerra.Adaxes.PowerShellModule.Directory.ADComputer
  • Softerra.Adaxes.PowerShellModule.Directory.ADOrganizationalUnit

  • Type:

  • Object

  • Position:

  • 1

  • Required:

  • True

  • Default Value:

  • None

  • Accept pipeline input:

  • True (ByValue)

  • Accept wildcard characters:

  • False

-Instance

Specifies a modified copy of a directory object to use to update the actual object. When you specify this parameter, any modifications made to the modified copy of the object are also made to the corresponding directory object. The cmdlet only updates the object properties that changed.

When you specify the Instance parameter, you cannot specify other parameters that set properties on the object.

The following is an example of how to use the Get-AdmObject cmdlet to retrieve an instance of the object. The object is modified by using the PowerShell command line. Then the Set-AdmObject cmdlet saves the changes to the directory object.

Step 1: Get a local instance of the object:

$ObjectInstance = Get-AdmObject -Identity "CN=someObject, DC=contoso,DC=com"

Step 2: Modify one or more properties of the object instance:

$ObjectInstance.Description = "New Description"

Step3: Save your changes to the object:

Set-AdmObject -Instance $ObjectInstance

  • Type:

  • ADObject

  • Position:

  • Named

  • Required:

  • True

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

-Partition

Specifies the distinguished name of an Active Directory partition. The distinguished name must be one of the naming contexts on the current directory server. The cmdlet searches this partition to find the object defined by the Identity parameter.

In many cases, a default value will be used for the Partition 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.

  • If the Identity parameter is set to a distinguished name, the default value of Partition is automatically generated from this distinguished name.
  • If running cmdlets from an Adaxes Active Directory provider drive, the default value of Partition is automatically generated from the current path in the drive.
  • If none of the previous cases apply, the default value of Partition will be set to the default partition or naming context of the target domain.

  • Type:

  • string

  • 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

-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

-Remove

Specifies that the cmdlet removes values of an object property. Use this parameter to remove one or more values of a property that cannot be modified using a cmdlet parameter. To remove an object property, use its schema name. You can set multiple values for a property by specifying a comma-separated list of values, and more than one property by separating them using a semicolon. The format for this parameter is:

-Remove @{Attribute1Name=value1, value2, ...; Attribute2Name=value1, value2, ...; AttributeXName=value1, value2, ...}

When you use the Add, Remove, Replace, and Clear parameters together, the parameters will be applied in the following sequence:

  • Remove
  • Add
  • Replace
  • Clear

  • Type:

  • Hashtable

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • Accept wildcard characters:

  • False

-Replace

Specifies values for an object property that will replace the current values. Use this parameter to replace one or more values of a property that cannot be modified using a cmdlet parameter. To modify an object property, use its schema name. You can set multiple values for a property by specifying a comma-separated list of values, and more than one property by separating them using a semicolon. The format for this parameter is:

-Replace @{Attribute1Name=value1, value2, ...; Attribute2Name=value1, value2, ...; AttributeXName=value1, value2, ...}

When you use the Add, Remove, Replace, and Clear parameters together, the parameters will be applied in the following sequence:

  • Remove
  • Add
  • Replace
  • Clear

  • Type:

  • Hashtable

  • Position:

  • Named

  • Required:

  • False

  • Default Value:

  • None

  • Accept pipeline input:

  • False

  • 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

-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

Softerra.Adaxes.PowerShellModule.Directory.AdmObject

A directory object is received by the Identity parameter.

Derived types, such as the following are also accepted:

  • Softerra.Adaxes.PowerShellModule.Directory.ADGroup
  • Softerra.Adaxes.PowerShellModule.Directory.ADUser
  • Softerra.Adaxes.PowerShellModule.Directory.ADComputer
  • Softerra.Adaxes.PowerShellModule.Directory.ADOrganizationalUnit

An object that was retrieved and then modified is received by the Instance parameter.

Outputs

None or Softerra.Adaxes.PowerShellModule.Directory.AdmObject

Returns the modified 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