Windows PowerShell Connector for FIM 2010 R2 xADSyncPSConnectorModule Sample Module

Article
1/17/2024

Tip
For feedback, click here.

The AD Sync PS Connector Module for Windows PowerShell sample code supports the connectors included in the Windows PowerShell Connector for FIM 2010 R2 Sample Connector Collection.

Updated content is now hosted at https://github.com/Microsoft/MIMPowerShellConnectors

Usage

You can use the AD Sync PS Connector Module sample with the Windows PowerShell Connector for FIM 2010 R2. To use the module, configure the Connectivity tab of the PowerShell Management Agent Designer with the following settings:

Parameter	Value
Common Module Script Name (with extension)	xADSyncPSConnectorModule.psm1
Common Module Script	Paste AD Sync PS Connector Module code as value

↑ Back to top

Windows PowerShell Module Script Code

001
002
003
004
005
006
007
008
009
010
011
012
013
014
015
016
017
018
019
020
021
022
023
024
025
026
027
028
029
030
031
032
033
034
035
036
037
038
039
040
041
042
043
044
045
046
047
048
049
050
051
052
053
054
055
056
057
058
059
060
061
062
063
064
065
066
067
068
069
070
071
072
073
074
075
076
077
078
079
080
081
082
083
084
085
086
087
088
089
090
091
092
093
094
095
096
097
098
099
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374

Set-PSDebug -Strict

function Get-xADSyncPSConnectorSetting
{
    [CmdletBinding()]
    param(
        [parameter(Mandatory = $true)]
        [ValidateNotNull()]
        [Alias('InputObject')]
        [System.Collections.ObjectModel.KeyedCollection[string], [Microsoft.MetadirectoryServices.ConfigParameter]]
        $ConfigurationParameters,
        [parameter(Mandatory = $true)]
        [ValidateNotNullOrEmpty()]
        [string]
        $Name,
        [parameter(Mandatory = $true)]
        [ValidateSet('Global', 'Partition', 'RunStep')]
        [string]
        $Scope,
        $DefaultValue
    )
    process
    {
        try
        {
            $scopedName = '{0}_{1}' -f $Name,$Scope

            if ($ConfigurationParameters[$scopedName].Value)
            {
                return $ConfigurationParameters[$scopedName].Value
            }
            elseif ($PSBoundParameters.ContainsKey('DefaultValue'))
            {
                return $DefaultValue
            }
            else
            {
                return $null
            }
        }
        catch [System.Collections.Generic.KeyNotFoundException]
        {
            # if they gave us a default, go ahead and return it
            if ($PSBoundParameters.ContainsKey('DefaultValue'))
            {
                return $DefaultValue
            }
            else
            {
                throw
            }
        }
    }
}

function Get-xADSyncPSConnectorFolder
{
    [CmdletBinding()]
    [OutputType([string])]
    param(
        [parameter(Mandatory = $true, Position = 0)]
        [ValidateSet('ManagementAgent', 'Extensions')]
        [string]
        $Folder
    )

    switch ($Folder)
    {
        'ManagementAgent'
        {
            return [Microsoft.MetadirectoryServices.MAUtils]::MAFolder
        }
        'Extensions'
        {
            return [Microsoft.MetadirectoryServices.Utils]::ExtensionsDirectory
        }
        default
        {
            throw "Folder '$Folder' is not supported"
        }
    }
}

#region Schema Helpers
function New-xADSyncPSConnectorSchema
{
    [CmdletBinding()]
    [OutputType([Microsoft.MetadirectoryServices.Schema])]
    param()

    return [Microsoft.MetadirectoryServices.Schema]::Create()
}

function New-xADSyncPSConnectorSchemaType
{
    [CmdletBinding()]
    [OutputType([Microsoft.MetadirectoryServices.SchemaType])]
    param(
        [ValidateNotNullOrEmpty()]
        [string]
        $Name,
        [Switch]
        $LockAnchorAttributeDefinition
    )

    return [Microsoft.MetadirectoryServices.SchemaType]::Create($Name, $LockAnchorAttributeDefinition.ToBool())
}

function Add-xADSyncPSConnectorSchemaAttribute
{
    [CmdletBinding(DefaultParameterSetName = 'Singlevalued')]
    param(
        [parameter(Mandatory = $true, ValueFromPipeline = $true)]
        [Microsoft.MetadirectoryServices.SchemaType]
        [ValidateNotNull()]
        $InputObject,
        [ValidateNotNullOrEmpty()]
        [string]
        [parameter(Mandatory = $true, ParameterSetName='Anchor')]
        [parameter(Mandatory = $true, ParameterSetName = 'Multivalued')]
        [parameter(Mandatory = $true, ParameterSetName = 'Singlevalued')]
        $Name,
        [parameter(ParameterSetName='Anchor')]
        [Switch]
        $Anchor,
        [parameter(ParameterSetName = 'Multivalued')]
        [Switch]
        $Multivalued,
        [parameter(Mandatory = $true, ParameterSetName='Anchor')]
        [parameter(Mandatory = $true, ParameterSetName = 'Multivalued')]
        [parameter(Mandatory = $true, ParameterSetName = 'Singlevalued')]
        [ValidateSet('Binary', 'Boolean', 'Integer', 'Reference', 'String')]
        [string]
        $DataType,
        [parameter(Mandatory = $true, ParameterSetName='Anchor')]
        [parameter(Mandatory = $true, ParameterSetName = 'Multivalued')]
        [parameter(Mandatory = $true, ParameterSetName = 'Singlevalued')]
        [ValidateSet('ImportOnly', 'ExportOnly', 'ImportExport')]
        [string]
        $SupportedOperation
    )

    process
    {
        switch ($PSCmdlet.ParameterSetName)
        {
            'Singlevalued'
            {
               $InputObject.Attributes.Add([Microsoft.MetadirectoryServices.SchemaAttribute]::CreateSingleValuedAttribute($Name, $DataType, $SupportedOperation))
            }
            'Multivalued'
            {
                if ($Multivalued.ToBool() -eq $true)
                {
                    $InputObject.Attributes.Add([Microsoft.MetadirectoryServices.SchemaAttribute]::CreateMultiValuedAttribute($Name, $DataType, $SupportedOperation))
                }
                else
                {
                    $InputObject.Attributes.Add([Microsoft.MetadirectoryServices.SchemaAttribute]::CreateSingleValuedAttribute($Name, $DataType, $SupportedOperation))
                }
            }
            'Anchor'
            {
                if ($Anchor.ToBool() -eq $true)
                {
                    $InputObject.Attributes.Add([Microsoft.MetadirectoryServices.SchemaAttribute]::CreateAnchorAttribute($Name, $DataType, $SupportedOperation))
                }
                else
                {
                    $InputObject.Attributes.Add([Microsoft.MetadirectoryServices.SchemaAttribute]::CreateSingleValuedAttribute($Name, $DataType, $SupportedOperation))
                }
            }
            default
            {
                throw "Parameter set '$($PSCmdlet.ParameterSetName)' is not supported"
            }
        }
    }
}
#endregion

#region Partition Helpers
function New-FIMPSConnectorPartition
{
    [CmdletBinding()]
    [OutputType([Microsoft.MetaDirectoryServices.Partition])]
    param(
        [parameter(Mandatory = $true)]
        [Guid]
        $Identifier,
        [parameter(Mandatory = $true)]
        [ValidateNotNullOrEmpty()]
        [string]
        $DistinguishedName,
        [parameter(Mandatory = $false)]
        [ValidateNotNullOrEmpty()]
        [string]
        $DisplayName
    )

    if ($PSBoundParameters.ContainsKey('DisplayName'))
    {
        return [Microsoft.MetadirectoryServices.Partition]::Create($Identifier, $DistinguishedName, $DisplayName)
    }
    else
    {
        return [Microsoft.MetadirectoryServices.Partition]::Create($Identifier, $DistinguishedName)
    }
}
#endregion
function New-xADSyncPSConnectorHierarchyNode
{
    [CmdletBinding()]
    [OutputType([Microsoft.MetadirectoryServices.HierarchyNode])]
    param(
        [parameter(Mandatory = $true)]
        [ValidateNotNullOrEmpty()]
        [string]
        $DistinguishedName,
        [parameter(Mandatory = $true)]
        [ValidateNotNullOrEmpty()]
        [string]
        $DisplayName
    )

    return [Microsoft.MetadirectoryServices.HierarchyNode]::Create($DistinguishedName, $DisplayName)
}
#region Hierarchy Helpers

#endregion

#region Import Helpers
function New-xADSyncPSConnectorCSEntryChange
{
    [CmdletBinding()]
    [OutputType([Microsoft.MetadirectoryServices.CSEntryChange])]
    param(
        [parameter(Mandatory = $true)]
        [ValidateNotNullOrEmpty()]
        [string]
        $ObjectType,
        [parameter(Mandatory = $true)]
        [ValidateSet('Add', 'Delete', 'Update', 'Replace', 'None')]
        [string]
        $ModificationType,
        [ValidateNotNullOrEmpty()]
        [Alias('DistinguishedName')]
        [string]
        $DN,
        [ValidateNotNullOrEmpty()]
        [Alias('RelativeDistinguishedName')]
        [string]
        $RDN
    )

    $csEntry = [Microsoft.MetadirectoryServices.CSEntryChange]::Create()
    $csEntry.ObjectModificationType = $ModificationType
    $csEntry.ObjectType = $ObjectType

    if ($PSBoundParameters.ContainsKey('DN'))
    {
        $csEntry.DN = $DN
    }

    if ($PSBoundParameters.ContainsKey('RDN'))
    {
        $csEntry.RDN = $RDN
    }

    Write-Output $csEntry
}

function Add-xADSyncPSConnectorCSAttribute
{
    [CmdletBinding()]
    param(
        [parameter(Mandatory = $true, ValueFromPipeline = $true)]
        [Microsoft.MetadirectoryServices.CSEntryChange]
        [ValidateNotNull()]
        $InputObject,
        [parameter(Mandatory = $true)]
        [ValidateSet('Add', 'Update', 'Delete', 'Replace', 'Rename')]
        [string]
        $ModificationType,
        [ValidateNotNullOrEmpty()]
        [string]
        $Name,
        $Value
    )

    process
    {
        if ($ModificationType -ne 'Rename' -and $Name -eq $null)
        {
            throw 'Name parameter is required'
        }

        if ($ModificationType -ne 'Delete' -and $Value -eq $null)
        {
            throw 'Value parameter is required'
        }

       switch ($ModificationType)
       {
            'Add'
            {
                $InputObject.AttributeChanges.Add([Microsoft.MetadirectoryServices.AttributeChange]::CreateAttributeAdd($Name, $Value))
            }
            'Update'
            {
                $InputObject.AttributeChanges.Add([Microsoft.MetadirectoryServices.AttributeChange]::CreateAttributeUpdate($Name, $Value))
            }
            'Delete'
            {
                $InputObject.AttributeChanges.Add([Microsoft.MetadirectoryServices.AttributeChange]::CreateAttributeDelete($Name))
            }
            'Replace'
            {
                $InputObject.AttributeChanges.Add([Microsoft.MetadirectoryServices.AttributeChange]::CreateAttributeReplace($Name, $Value))
            }
            'Rename'
            {
                $InputObject.AttributeChanges.Add([Microsoft.MetadirectoryServices.AttributeChange]::CreateNewDN($Value))
            }
            default
            {
                throw "Modification type $ModificationType is not supported"
            }
       }
    }
}
#endregion

function New-GenericObject
{
    [CmdletBinding()]
    param (
      [parameter(Mandatory = $true)]
      [ValidateNotNullOrEmpty()]
      [string]
      $TypeName,
      [parameter(Mandatory = $true)]
      [ValidateNotNullOrEmpty()]
      [string[]]
      $TypeParameters,
      [parameter(Mandatory = $false)]
      [object[]]
      $ConstructorParameters
    )

    $genericTypeName = $typeName + '
`r`n' + $typeParameters.Count
    $genericType = [Type]$genericTypeName

    if (!$genericType)
    {
      throw "Could not find generic type $genericTypeName"
    }

    ## Bind the type arguments to it
    $typedParameters = [Type[]] $typeParameters
    $closedType = $genericType.MakeGenericType($typedParameters)

    if (!$closedType)
    {
     throw "Could not make closed type $genericType"
    }

    ## Create the closed version of the generic type. Don't forget comma prefix
    ,[Activator]::CreateInstance($closedType, $constructorParameters)
}

Export-ModuleMember -Function * -Verbose:$false -Debug:$false

↑ Back to top

Share via

Windows PowerShell Connector for FIM 2010 R2 xADSyncPSConnectorModule Sample Module

Usage

Windows PowerShell Module Script Code

See Also

Additional resources