Cmdlets for Microsoft Active Directory

Build 23.0.8839

Getting Started

Connecting to Microsoft Active Directory

Establishing a Connection shows how to authenticate to Microsoft Active Directory and configure any necessary connection properties. You can also configure cmdlet capabilities through the available Connection properties, from data modeling to firewall traversal. The Advanced Settings section shows how to set up more advanced configurations and troubleshoot connection errors.

Connecting from PowerShell

The CData Cmdlets PowerShell Module for Microsoft Active Directory provides a familiar way to interact with Microsoft Active Directory from PowerShell. The cmdlets provide a standard PowerShell interface and an SQL interface to live data. The CData cmdlets enable you to work with Microsoft Active Directory using standard PowerShell objects; you can chain the cmdlets to each other or other cmdlets in pipelines. The cmdlets also support PowerShell debug streams.

Data Manipulation with Cmdlets

See Establishing a Connection to learn how to get started with the Connect-AD cmdlet. You can then pass the ADConnection object returned to other cmdlets for accessing data:

  • Select-AD
  • Add-AD
  • Update-AD
  • Remove-AD

Executing SQL from PowerShell

You can execute any SQL query with the Invoke-AD cmdlet.

Accessing Debug Output from Streams

See Capturing Errors and Logging to obtain the debug output through PowerShell streams.

PowerShell Version Support

The standard cmdlets are supported in PowerShell 2, 3, 4, and 5.

Microsoft Active Directory Version Support

The cmdlet provides SQL-based access to Microsoft Active Directory through the LDAP protocol. The cmdlet is a standard LDAP client that supports LDAP v2 and v3.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839