The following are parameters for the -cmd transfer command
Using this command you can perform a "Tranfer Permissions" operation
|
-userLogin |
specifies the user for which you want to transfer the permissions from (source user) |
|
-targetUserLogin
or -csvUsersFile |
specifies the user for which you want to transfer the permissions to (target user) or specifies the CSV file and path to the file with the user mapping |
|
-csvFile |
specifies the CSV file and path to the file which contains the Site to run this operation against |
|
-includesubsites |
specifies whether you want to transfer permissions from within sites and their sub sites |
|
-includelists |
specifies whether you want to transfer permissions from within lists |
|
-includeItems |
specifies whether you want to transfer permissions from within items (may be time consuming) |
|
-includeSiteCollectionAdmin |
specifies whether you want to remove source site collection administrator permissions |
|
-removeSource |
specifies whether you want to also remove the permissions of the source user |
Example:
Essentials -cmd transfer -srcuser DOMAIN\user -srcepass passwd -userLogin DOMAIN\user -targetUserLogin DOMAIN\user -csvFile "fs path" -includeSubsites -includeLists -includeItems -removeSource -noSplash
Essentials -cmd transfer -srcuser DOMAIN\user -srcepass passwd -csvUsersFile "fs path" -csvFile "fs path" -includeSubsites -includeLists -includeItems -removeSource -noSplash
The following are parameters for the -cmd remove command
Using this command you can perform a "Remove Permissions" operation
|
-userLogin
or -csvUsersFile |
specifies the user/group for which you want to remove the permissions or specifies the CSV file and path to the file with the user mapping |
|
-csvFile |
specifies the CSV file and path to the file which contains the Site to run this operation against |
|
-includesubsites |
specifies whether you want to remove permissions from within sites and their sub sites |
|
-includelists |
specifies whether you want to remove permissions from within lists |
|
-includeItems |
specifies whether you want to remove permissions from within items (may be time consuming) |
|
-includeSiteCollectionAdmin |
specifies whether you want to remove user(s) as a Site Collection Administrator. Only applies to root site collections. |
|
-removeSource |
specifies whether you want to also remove the permissions of the source user (required for this -remove operation) |
Examples:
Essentials -cmd remove -srcuser user@contoso.com -srcepass encryptedPassword -userLogin user2@contoso.com -csvFile "D:\Folder\fileName.csv" -includeSiteCollectionAdmin -includeSubsites -includeLists -includeItems -removeSource -noSplash
Essentials -cmd remove -srcuser CONTOSO\user -srcepass encryptedPassword -csvUsersFile "D:\Folder\UsersfileName.csv" -csvFile "D:\Folder\SitesfileName.csv" -includeSiteCollectionAdmin -includeSubsites -includeLists -includeItems -removeSource -noSplash
The following are parameters for the -cmd Inventory command
Using this command you can generate a Permission Inventory Report
|
-csvFile |
specifies the CSV file and path to where you want to save this report |
|
-includesubsites |
specifies whether you want to include site and sub sites permissions |
|
-includelists |
specifies whether you want to include list and library permissions |
|
-includeItems |
specifies whether you want to include item permissions |
|
-includeInherited |
specifies whether you want to include inherited permissions |
|
-includeMembership |
specifies whether you want to include group membership |
|
-limitMembership |
if group membership is included, limit the group membership to this value |
|
-saveReportToSp |
specifies that the report will be uploaded and saved to SharePoint |
|
-trgtsite |
if saved to SharePoint, specifies the site URL that the report should be saved for |
|
-trgtlist |
if saved to SharePoint, specifies the library that the report should be saved for |
|
-trgtuser [name] |
target site user name |
|
-trgtepass [password] |
target site user password |
|
-trguseproxy |
specifies that proxy should be used to pass authentication on the target site collection |
Example:
Essentials -cmd inventory -srcuser DOMAIN\user -srcepass passwd -csvFile "fs path" -includesubsites -includelists -includeItems -includeInherited -includeMembership -limitMembership 3 -noSplash
The following are parameters for the -cmd InheritanceReport command
Using this command you can generate an Inheritance report.
|
-csvFile |
specifies the csv file path where you want to store your report. |
|
-includesubsites |
specifies whether you want to include the site level in the report. |
|
-includelists |
specifies whether you want to include the lists level in the report. |
|
-srcsite |
specifies the site collection for which the report will be generated. |
|
-srcuser |
specifies the user login which will be used to pass authentication on the source site collection. |
|
-srcepass |
specifies the user encrypted password that will be used to pass authentication on the source site collection. |
Example:
Essentials -cmd inheritanceReport srcsite http://host/site -srcuser DOMAIN\user -srcepass passwd -csvFile "fs path" -includesubsites -includelists -includeItems -noSplash
