Script repository

Update property pattern item with names of groups located in a container/OU

Updated on: Jan 18, 2026, Views: 4316

Miscellaneous

The script updates values allowed for a property by a property pattern with the names of groups located in a container/OU. To execute the script, create a business rule, custom command or scheduled task configured for the OrganizationalUnit or Container object type.

Parameters

  • $patternName - the name of the property pattern to update.
  • $propertyToUpdate - the name of the property to update allowed values for.
$patternName = "User" # TODO: modify me
$propertyToUpdate = "department" # TODO: modify me

function SearchObjects($criteria, $containerPath)
{
    $searcher = $Context.BindToObject($containerPath)
    $searcher.Criteria = $criteria
    $searcher.SearchScope = "ADS_SCOPE_SUBTREE"
    $searcher.PageSize = 500
    $searcher.ReferralChasing = "ADS_CHASE_REFERRALS_NEVER"     
    
    try
    {
        $searchResultIterator = $searcher.ExecuteSearch()
        $searchResults = $searchResultIterator.FetchAll()
        
        return ,$searchResults
    }
    finally
    {
        # Release resources
        if ($searchResultIterator){ $searchResultIterator.Dispose() }
    }
}

# Get all groups in the target OU.
$criteria = New-AdmCriteria "group"
$groupSearchResults = SearchObjects $criteria $Context.TargetObject.AdsPath

# Exit if no groups found.
if ($groupSearchResults.Length -eq 0)
{
    return
}

# Get group names.
$groupNames = New-Object System.Collections.ArrayList
foreach ($searchResult in $groupSearchResults)
{
    $groupNames.Add($searchResult.Properties["name"].Value)
}

# Find property pattern.
$propertyPatternsPath = $Context.GetWellKnownContainerPath("PropertyPatterns")
$criteria = New-AdmCriteria "adm-PropertyPattern" -Expression {name -eq $patternName}
$patternSearchResults = SearchObjects $criteria $propertyPatternsPath

if ($patternSearchResults.Length -gt 1)
{
    $Context.LogMessage("Found more than one Property Pattern with name '$patternName'.", "Warning")
    return
}
if ($patternSearchResults.Length -eq 0)
{
    $Context.LogMessage("Property Pattern '$patternName' does not exist.", "Error")
    return
}

# Bind to the property pattern.
$pattern = $Context.BindToObject($patternSearchResults[0].AdsPath)

# Delete the pattern item for the property.
foreach ($item in $pattern.Items)
{
    if ($item.PropertyName -ieq $propertyToUpdate)
    {
        $pattern.Items.Remove($item)
        break
    }
}

# Create list of values for the property.
$item = $pattern.Items.Create()
$item.PropertyName = $propertyToUpdate

$constraints = $item.GetConstraints()
$constraint = $constraints.Create(
    "ADM_PROPERTYCONSTRAINTTYPE_VALUERANGE")
$constraint.AreValuesDenied = $False
$constraint.Values = $groupNames.ToArray()
$constraints.Add($constraint)
$item.SetConstraints($constraints)

# Update property pattern.
$item.SetInfo()
$pattern.Items.Add($item)

Comments 0

You must be signed in to comment.

    Got questions?

    Support Questions & Answers

    We use cookies to improve your experience.
    By your continued use of this site you accept such use.
    For more details please see our privacy policy and cookies policy.