Cmdlets for Microsoft SharePoint

Build 24.0.9060

Getting Started

Connecting to Microsoft SharePoint

Establishing a Connection shows how to authenticate to Microsoft SharePoint 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 SharePoint provides a familiar way to interact with Microsoft SharePoint 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 SharePoint 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-SharePoint cmdlet. You can then pass the SharePointConnection object returned to other cmdlets for accessing data:

  • Select-SharePoint
  • Add-SharePoint
  • Update-SharePoint
  • Remove-SharePoint

Executing SQL from PowerShell

You can execute any SQL query with the Invoke-SharePoint 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 SharePoint Version Support

The cmdlet supports all versions of Microsoft SharePoint that support the SOAP API. This includes: Windows SharePoint Services 3.0, SharePoint Server 2007+ (2010, 2013, etc.), and SharePoint Online. The cmdlet models the custom lists of your SharePoint site as bidirectional tables; when you connect, the cmdlet retrieves the metadata for these tables by calling SharePoint Web services. Supported authentication schemes are NTLM, Basic, Digest, Forms, Kerberos, SSO, STS (security token services), and SharePoint authentication cookies.

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