Chat now with support
Chat with Support

NOTICE! We are upgrading our support telephone services, implementing Genesys, starting the week of May 19, 2025

ControlPoint 8.8 - User Guide

Preface Getting Started with ControlPoint Using Discovery to Collect Information for the ControlPoint Database Cache Searching for SharePoint Sites Managing SharePoint Objects Using ControlPoint Policies to Control Your SharePoint Environment Managing SharePoint User Permissions Data Analysis and Reporting
Specifying Parameters for Your Analysis Analysis Results Display Generating a SharePoint Summary Report Analyzing Activity Analyzing Object Properties Analyzing Storage Analyzing Content Generating a SharePoint Hierarchy Report Analyzing Trends Auditing Activities and Changes in Your SharePoint Environment Analyzing SharePoint Alerts Analyzing ControlPoint Policies Analyzing Users and Permissions The ControlPoint Task Audit Viewing Logged Errors
Scheduling a ControlPoint Operation Saving, Modifying and Running Instructions for a ControlPoint Operation Using the ControlPoint Governance Policy Manager Using Sensitive Content Manager to Analyze SharePoint Content for Compliance Using ControlPoint Sentinel to Detect Anomalous Activity Provisioning SharePoint Site Collections and Sites Default Menu Options for ControlPoint Users About Us

Running ControlPoint Actions in PowerShell

You can run ControlPoint actions either directly by entering commands and parameters from the PowerShell command line or by using the command line to run an xml file containing the commands and parameters.  Most actions can be run for any level of the SharePoint Hierarchy—farm, Web application (WAP), site collection (SITE), or site (WEB).  You can also choose to have a ControlPoint Task Audit generated as a .pdf file and saved to the file system folder on the server of your choice.  (Regardless of whether you choose to have a Task Audit saved as a .pdf, actions will be recorded in the Task Audit that is accessible from the ControlPoint application interface.)

NOTE:  Parameters, valid values, and examples for each action are covered in this guide.

Account Login Requirements

You can run ControlPoint actions in PowerShell from a remote desktop or console session on any Web front-end server on which ControlPoint is installed.  The account you use to log into the server machine must have the appropriate permissions within ControlPoint for the scope of the action being performed.

Refer to the topic “ControlPoint Security” in the ControlPoint User’s Guide for complete detail.

It may be necessary to perform additional steps to grant the appropriate permissions.  Refer to the following Microsoft TechNet articles for more details:

§http://technet.microsoft.com/en-us/library/ee806878.aspx

§http://technet.microsoft.com/en-us/library/ff607596.aspx

The PowerShell Command Line

The advantage of using a command line is that you can "pipe" cmdlets together to perform multiple actions.  However, each cmdlet must operate on the same scope (url and object type).  This information is passed from one cmdlet to the next.

The example below shows a PowerShell command that will back up permissions on the Skunkworks site, then deletes the permissions of Mark Twain, Margaret Meade, and Isaac Asimov from that site.

Because both actions are operating on the same object, the url and type need to be specified only once, in the first cmdlet. After the first action is carried out, these parameters are passed to the next cmdlet.

Backup-UserPermissions -Type WEB -url http://2016sharepoint/sites/alpha/skunkworks | Delete-UserPermissions -UserLoginNames 2016sharepoint\marktwain,sbellum\margaretmeade,sbellum\isaacasimov

xml Files

With an xml file, you can act on multiple objects.  However, only one ControlPoint action can be run per file.

NOTE:  xml templates for ControlPoint actions are located in the folder C:\Program Files\Metalogix\ControlPoint\Support\PowerShell.  When you upgrade from a previous version of ControlPoint, these templates will be overwritten with newer versions.  You should always make sure that your xml files use the most up-to-date templates.

The example below shows an xml file formatted to run the Delete User Permissions action on two sites within the Clients Web application.

PowerShell Multi Object xml

To run the xml from the PowerShell command line, enter the Cmdlet, the parameter -FilePath, and the path to the xml file.  For this example:

Delete-UserPermissions -FilePath C:\Temp\xml\DeleteUserPermissions.xml

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating