Backup-UserPermissions
Following are the PowerShell cmdlet parameters and xml syntax for the ControlPoint Backup User Permissions action.
PowerShell Parameters
|
Parameter |
Description |
|---|---|
|
Backup-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. |
|
-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
Backup-UserPermissions -Type FARM -Url http://QuestTest/sites/alpha/
-TaskAuditPath C:\Temp\TaskAudits
xml Tags
REMINDER: Xml templates for ControlPoint actions are located in the folder C:\Program Files\Metalogix\ControlPoint\Support\Powershell.
|
Tags |
Description |
|---|---|
|
<BackupPermissionsContract...> |
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. |
|
<TaskAuditPath> (Optional) |
If you want to save a ControlPoint Task Audit for the action as a .pdf file, the path to the directory on the server where you want the file to be saved. |
Example xml File Contents
PowerShell Command to Run xml
Backup-UserPermissions -FilePath C:\Temp\xml\BackupUserPermissions.xml