Chat now with support
Chat with Support

Metalogix ControlPoint 8.2 - User Guide

Preface Getting Started with ControlPoint Using Discovery to Collect Information for the ControlPoint Database Cache Searching for SharePoint Sites Managing SharePoint Objects
Accessing SharePoint Pages Viewing Properties of an Object within the SharePoint Hierarchy Creating Dashboards for Monitoring Statistics within Your SharePoint Farm Setting Object Properties Managing Site Collection and Site Features Managing Audit Settings Creating and Managing SharePoint Alerts Setting ControlPoint Alerts Managing Metadata Copying and Moving SharePoint Objects (Version 8.0 and Earlier) Moving a Site Collection to Another Content Database Deleting Sites Deleting Lists Archiving Audit Log Data Before Moving or Deleting a Site Collection Duplicating a Workflow Definition from one List or Site to Others Removing a Workflow from One or More Lists (or Sites)
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 Executing Instructions for a ControlPoint Operation Using the ControlPoint Governance Policy Manager (SharePoint 2010 and Later) Using Sensitive Content Manager to Analyze SharePoint Content for Compliance Using ControlPoint Sentinel to Detect Anomalous Activity Default Menu Options for ControlPoint Users About Us

Delete-UserPermissions

Following are the PowerShell cmdlet parameters and xml syntax for the ControlPoint Delete User Permissions action.

PowerShell Parameters

Parameter

Description

Delete-UserPermissions

The cmdlet name

-Type

The level of the hierarchy containing the SharePoint object(s) that will be acted on.  Valid values are:

§FARM

§WAP

§SITE

§WEB

-Url

The url of the SharePoint object to act on.

NOTE:  If the action is to be performed on a farm, Web application, or site collection, you can use the url for any site within that scope.

-UserLoginNames

Login name(s) of the user(s) whose permissions will be deleted.  Enter multiple login names as  a comma-separated list.

-ReassignTo

(Optional)

Login name(s) of the user(s) to whom you want to reassign deleted permissions.  Enter multiple login names as  a comma-separated list.

-IncludeChildren

An indication of whether you want the action to include child sites.

 

§If -Type is FARM, WAP, or SITE, $true is the only valid value.

§If -Type is WEB, valid values are $true or $false.

 

NOTE:  If this parameter is omitted:

§for FARM, WAP, or SITE, a value of true will be assumed

§for WEB, a value of false will be assumed.

-DeleteFromAllPeople

An indication of whether you want the deleted user(s) to be removed from the site collection All People list.  Valid values are:

§$true

§$false

NOTE:  If this parameter is omitted, a value of false will be assumed.

-DeleteAlerts

An indication of whether you want any alerts that have been created for the user(s) to be deleted.  Valid values are:

§$true

§$false

NOTE:  If this parameter is omitted, a value of false will be assumed.

-TaskAuditPath

(Optional)

If you want to save a ControlPoint Task Audit for the action as a .pdf file, the path to the directory where you want the file to be saved.

Example PowerShell Cmdlet with Parameters

Delete-UserPermissions -url http://2008SharePoint/alpha -Type WAP -UserLoginNames 2008SharePoint\jamesjoyce,2008SharePoint\marktwain -ReassignTo 2008SharePoint\fscottfitzgerald -IncludeChildren $true -DeleteFromAllPeople $true -DeleteAlerts $true -TaskAuditPath C:\Temp\TaskAudits

xml Tags

Tag

Description

<DeleteUserPermissionsContract...>

The action to be performed

<SharePointObjects>

The container for all of the objects that you want to include in the operation.

<SharePointObject>

The container for the current object.

<SPHierarchyLevel>

The level of the hierarchy for the SharePoint object(s)  that will be acted on.  Valid values are:

§FARM

§WAP

§SITE

§WEB

<Url>

The url of the SharePoint object to act on.

NOTE:  If the action is to be performed on a farm, Web application, or site collection, you can use the url for any site within that scope.

<IncludeChildren>

An indication of whether you want the action to include child sites.

 

§If SPHierarchyLevel=FARM, WAP, or SITE, true is the only valid value.

If SPHierarchyLevel=WEB, valid values are true or false.

<UserLoginNames>

<string>

List of login names of the users whose permissions will be deleted.  Enter each login name as a separate string.

<ReassignTo>

<string>

List of login names of the users to whom you want to reassign deleted permissions.  Enter each login name as a separate string.

<DeleteFromAllPeople>

An indication of whether you want the user(s) to be deleted from the site collection All People list.  Valid values are

§true

§false

<DeleteAlerts>

An indication of whether you want any alerts that have been created for the user(s) to be deleted.  Valid values are:

§true

§false

<TaskAuditPath>

(Optional)

If you want to generate a ControlPoint Task Audit (as a .pdf file) for the action, the path to the directory where you want the file to be saved.

Example xml File Contents

DeleteUserPermissions xml

PowerShell Command to Execute xml

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

 

Related Documents