June 2016 – PhoeNIXBird Networks

[SPS] Extract all of the documents and their versions from a site using PS

June 11, 2016 Andrei Rachita 0

So here is a way to do it:

# This script will extract all of the documents and their versions from a site. It will also
# download all of the list data and document library metadata as a CSV file.

Add-PSSnapin Microsoft.SharePoint.PowerShell -erroraction SilentlyContinue
# 
# $destination: Where the files will be downloaded to
# $webUrl: The URL of the website containing the document library for download
# $listUrl: The URL of the document library to download

#Where to Download the files to. Sub-folders will be created for the documents and lists, respectively.
$destination = "C:\Export"

#The site to extract from. Make sure there is no trailing slash.
$site = "http://2013.pbnet.pbnet.local"
$listTitle = "My Test Doclib"
# Function: HTTPDownloadFile
# Description: Downloads a file using webclient
# Variables
# $ServerFileLocation: Where the source file is located on the web
# $DownloadPath: The destination to download to

function HTTPDownloadFile($ServerFileLocation, $DownloadPath)
{
                $webclient = New-Object System.Net.WebClient
                $webClient.UseDefaultCredentials = $true
                $webclient.DownloadFile($ServerFileLocation,$DownloadPath)
}

function DownloadMetadata($sourceweb, $metadatadestination)
{
                Write-Host "Creating Lists and Metadata"
                $sourceSPweb = Get-SPWeb -Identity $sourceweb
                $metadataFolder = $destination+"\"+$sourceSPweb.Title+" Lists and Metadata"
                $createMetaDataFolder = New-Item $metadataFolder -type directory 
                $metadatadestination = $metadataFolder

                foreach($list in $sourceSPweb.Lists)
                {
                                Write-Host "Exporting List MetaData: " $list.Title
                                $ListItems = $list.Items 
                                $Listlocation = $metadatadestination+"\"+$list.Title+".csv"
                                $ListItems | Select * | Export-Csv $Listlocation  -Force
                }
}

# Function: GetFileVersions
# Description: Downloads all versions of every file in a document library
# Variables
# $WebURL: The URL of the website that contains the document library
# $DocLibURL: The location of the document Library in the site
# $DownloadLocation: The path to download the files to

function GetFileVersions($file)
{
                foreach($version in $file.Versions)
                {
                                #Add version label to file in format: [Filename]_v[version#].[extension]
                                $filesplit = $file.Name.split(".") 
                                $fullname = $filesplit[0] 
                                $fileext = $filesplit[1] 
                                $FullFileName = $fullname+"_v"+$version.VersionLabel+"."+$fileext                                     

                                #Can't create an SPFile object from historical versions, but CAN download via HTTP
                                #Create the full File URL using the Website URL and version's URL
                                $fileURL = $webUrl+"/"+$version.Url

                                #Full Download path including filename
                                $DownloadPath = $destinationfolder+"\"+$FullFileName

                                #Download the file from the version's URL, download to the $DownloadPath location
                                HTTPDownloadFile "$fileURL" "$DownloadPath"
                }
}

# Function: DownloadDocLib
# Description: Downloads a document library's files; called GetGileVersions to download versions.
# Credit 
# Used Varun Malhotra's script to download a document library
# as a starting point: http://blogs.msdn.com/b/varun_malhotra/archive/2012/02/13/10265370.aspx
# Variables
# $folderUrl: The Document Library to Download
# $DownloadPath: The destination to download to
function DownloadDocLib($folderUrl)
{
    $folder = $web.GetFolder($folderUrl)
    foreach ($file in $folder.Files) 
                {
        #Ensure destination directory
                                $destinationfolder = $destination + "\" + $folder.Url 
        if (!(Test-Path -path $destinationfolder))
        {
            $dest = New-Item $destinationfolder -type directory 
        }

        #Download file
        $binary = $file.OpenBinary()
        $stream = New-Object System.IO.FileStream($destinationfolder + "\" + $file.Name), Create
        $writer = New-Object System.IO.BinaryWriter($stream)
        $writer.write($binary)
        $writer.Close()

                                #Download file versions. If you don't need versions, comment the line below.
                                GetFileVersions $file
                }
}

# Function: DownloadSite
# Description: Calls DownloadDocLib recursiveley to download all document libraries in a site.
# Variables
# $webUrl: The URL of the site to download all document libraries
function DownloadSite($webUrl)
{
                $web = Get-SPWeb -Identity $webUrl

                #Create a folder using the site's name
                $siteFolder = $destination + "\" +$web.Title+" Documents"
                $createSiteFolder = New-Item $siteFolder -type directory 
                $destination = $siteFolder

                foreach($list in $web.Lists)
                {
                                if($list.BaseType -eq "DocumentLibrary" -and $list.Title -eq $listTitle)
                                {
                                                Write-Host "Downloading Document Library: " $list.Title
                                                $listUrl = $web.Url +"/"+ $list.RootFolder.Url
                                                #Download root files
                                                DownloadDocLib $list.RootFolder.Url
                                                #Download files in folders
                                                foreach ($folder in $list.Folders) 
                                                {
                                                DownloadDocLib $folder.Url
                                                }
                                }
                }
}

#Download Site Documents + Versions
DownloadSite "$site"

#Download Site Lists and Document Library Metadata
DownloadMetadata $site $destination

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

# This script will extract all of the documents and their versions from a site. It will also

# download all of the list data and document library metadata as a CSV file.

Add-PSSnapin Microsoft.SharePoint.PowerShell -erroraction SilentlyContinue

# $destination: Where the files will be downloaded to

# $webUrl: The URL of the website containing the document library for download

# $listUrl: The URL of the document library to download

#Where to Download the files to. Sub-folders will be created for the documents and lists, respectively.

$destination = "C:\Export"

#The site to extract from. Make sure there is no trailing slash.

$site = "http://2013.pbnet.pbnet.local"

$listTitle = "My Test Doclib"

# Function: HTTPDownloadFile

# Description: Downloads a file using webclient

# Variables

# $ServerFileLocation: Where the source file is located on the web

# $DownloadPath: The destination to download to

function HTTPDownloadFile($ServerFileLocation, $DownloadPath)

{

$webclient = New-Object System.Net.WebClient

$webClient.UseDefaultCredentials = $true

$webclient.DownloadFile($ServerFileLocation,$DownloadPath)

}

function DownloadMetadata($sourceweb, $metadatadestination)

{

Write-Host "Creating Lists and Metadata"

$sourceSPweb = Get-SPWeb -Identity $sourceweb

$metadataFolder = $destination+"\"+$sourceSPweb.Title+" Lists and Metadata"

$createMetaDataFolder = New-Item $metadataFolder -type directory

$metadatadestination = $metadataFolder

foreach($list in $sourceSPweb.Lists)

{

Write-Host "Exporting List MetaData: " $list.Title

$ListItems = $list.Items

$Listlocation = $metadatadestination+"\"+$list.Title+".csv"

$ListItems | Select * | Export-Csv $Listlocation -Force

}

# Function: GetFileVersions

# Description: Downloads all versions of every file in a document library

# Variables

# $WebURL: The URL of the website that contains the document library

# $DocLibURL: The location of the document Library in the site

# $DownloadLocation: The path to download the files to

function GetFileVersions($file)

{

foreach($version in $file.Versions)

{

#Add version label to file in format: [Filename]_v[version#].[extension]

$filesplit = $file.Name.split(".")

$fullname = $filesplit[0]

$fileext = $filesplit[1]

$FullFileName = $fullname+"_v"+$version.VersionLabel+"."+$fileext

#Can't create an SPFile object from historical versions, but CAN download via HTTP

#Create the full File URL using the Website URL and version's URL

$fileURL = $webUrl+"/"+$version.Url

#Full Download path including filename

$DownloadPath = $destinationfolder+"\"+$FullFileName

#Download the file from the version's URL, download to the $DownloadPath location

HTTPDownloadFile "$fileURL" "$DownloadPath"

}

# Function: DownloadDocLib

# Description: Downloads a document library's files; called GetGileVersions to download versions.

# Credit

# Used Varun Malhotra's script to download a document library

# as a starting point: http://blogs.msdn.com/b/varun_malhotra/archive/2012/02/13/10265370.aspx

# Variables

# $folderUrl: The Document Library to Download

# $DownloadPath: The destination to download to

function DownloadDocLib($folderUrl)

{

$folder = $web.GetFolder($folderUrl)

foreach ($file in $folder.Files)

{

#Ensure destination directory

$destinationfolder = $destination + "\" + $folder.Url

if (!(Test-Path -path $destinationfolder))

{

$dest = New-Item $destinationfolder -type directory

}

#Download file

$binary = $file.OpenBinary()

$stream = New-Object System.IO.FileStream($destinationfolder + "\" + $file.Name), Create

$writer = New-Object System.IO.BinaryWriter($stream)

$writer.write($binary)

$writer.Close()

#Download file versions. If you don't need versions, comment the line below.

GetFileVersions $file

}

# Function: DownloadSite

# Description: Calls DownloadDocLib recursiveley to download all document libraries in a site.

# Variables

# $webUrl: The URL of the site to download all document libraries

function DownloadSite($webUrl)

{

$web = Get-SPWeb -Identity $webUrl

#Create a folder using the site's name

$siteFolder = $destination + "\" +$web.Title+" Documents"

$createSiteFolder = New-Item $siteFolder -type directory

$destination = $siteFolder

foreach($list in $web.Lists)

{

if($list.BaseType -eq "DocumentLibrary" -and $list.Title -eq $listTitle)

{

Write-Host "Downloading Document Library: " $list.Title

$listUrl = $web.Url +"/"+ $list.RootFolder.Url

#Download root files

DownloadDocLib $list.RootFolder.Url

#Download files in folders

foreach ($folder in $list.Folders)

{

DownloadDocLib $folder.Url

}

#Download Site Documents + Versions

DownloadSite "$site"

#Download Site Lists and Document Library Metadata

DownloadMetadata $site $destination

[O365] Send service health reports via e-mail

June 11, 2016 Andrei Rachita 0

Since I got a requirement to think of a way to get O365 health status reports sent via e-mail, I created the below script:

# Required: An O365 Admin or an O365 partner (AOBO) with delegated admin rights on the tenant
# Throttle Limits: 25 requests/IP client/second, or 5 requests/user account/minute

<#
    .Synopsis
      Gets office 365 events
    .DESCRIPTION
       Users the Office 365 API to get all tenant events - https://msdn.microsoft.com/en-us/library/office/dn776043(v=office.15).aspx 
    .EXAMPLE
       get-O365Events
    .EXAMPLE
        get-O365Events -last 5 
    [Can add username in now]
        get-O365Events -username email@address.com
    #>

   
  function Get-O365Events
    {
        [CmdletBinding()]
        [Alias()]
        [OutputType([int])]
        Param
        (
            # Param1 help description
            [Parameter(Mandatory=$false,
                       ValueFromPipelineByPropertyName=$false,
                       Position=0)]
            [int]$last = 0,
            [string]$username
    
          
        )
    
        Begin
        {
        
         Try{
                # Getting Tenant Credentials


                #Get Credentials
                #Read variables from console
                $GlobalAdmin = "admin@tenant.onmicrosoft.com"
                $GlobalAdminPassword = "yourpassword"
                #Connecting
                $SecurePass = ConvertTo-SecureString -string $GlobalAdminPassword -AsPlainText -Force
                $cred=New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $GlobalAdmin, $SecurePass
                


                $Json = (@{userName=$cred.username;password=$cred.GetNetworkCredential().password;} | convertto-json).tostring()
                $cookie = (invoke-restmethod -contenttype "application/json" -method Post -uri "https://api.admin.microsoftonline.com/shdtenantcommunications.svc/Register" -body $json).RegistrationCookie

                #We now need to obtain our authentication cookie by calling the Register method with our Office 365 username and password. 
                #The Register method will return a cookie which can be used to authenticate subsequent requests for up to 2 days. Each additional method will return 
                #an updated Cookie, which extends the life of the cookie for another 48 hours.
                #The Service URL as per the MSDN documentation is "https://api.admin.microsoftonline.com/shdtenantcommunications.svc/". 
                #The Method that we are calling to obtain the cookie is the Register method.. To call this method, we add the method name to the URL, so that 
                #it is "https://api.admin.microsoftonline.com/shdtenantcommunications.svc/Register". We then invoke the web request with our username and password in JSON format
                #The method will return several properties, one of which is our RegistrationCookie. We need to store this cookie for future API requests.



                #preferredEventType -- "0" to represents a Service Incident, "1" to represent a Maintenance Event, and "2" to represent a Message Center communication 
                $load = (@{lastCookie=$cookie;locale="en-US";preferredEventTypes=@(0,1,2);} | convertto-json).tostring()
                $events = (invoke-restmethod -contenttype "application/json" -method Post -uri "https://api.admin.microsoftonline.com/shdtenantcommunications.svc/GetEvents" -body $load)
            }
            Catch{
                     Write-Warning -Message "Please Check your credentials"; break
                 }
                Finally{}
        
        
        }
        Process
        {
        $newEvent = foreach($evnt in $events.events){
                                  New-Object psobject -Property @{
                                                                ID = $evnt.ID
                                                                Title = $evnt.Title
                                                                ServiceAftected = $evnt.AffectedServiceHealthStatus.servicename
                                                                Status = $evnt.Status
                                                                Time = $evnt.starttime
                                                                LastUpdated = $evnt.LastUpdatedTime
                                                                Message = $evnt.messages.messagetext
                                                               } 
                                                               
                                    }
        }
        End
        {
       if($last -eq 0){$last = 10}
        $newEvent| sort -property Time | select -Property Title,ServiceAftected,Status, Time,LastUpdated, message -Last $last | fl 
        }
    }

#timestrapping log
$timestamp = get-date -format “yyyyMMdd_hhmmtt”
$filenameStart = “O365ServiceReport_for_”
#Note that the c:\O365R folder has to be present on the drive
cd c:\O365R\
$filepath = (“{0}{1}.csv” -f $filenamestart, $timestamp)

#Exporting to pre-defined folder
Get-O365Events |Out-File $filepath


#Defining logs folder and getting latest item
$logdir="C:\O365R"
$lastlog=Get-ChildItem $logdir | Sort-Object LastAccessTime -Descending |Select-Object -First 1
$file=$lastlog.name

#sending mail with last logs using O365 SMTP
$GlobalAdmin = "admin@tenant.onmicrosoft.com"
$GlobalAdminPassword = "yourpassword"
#Connecting
$SecurePass = ConvertTo-SecureString -string $GlobalAdminPassword -AsPlainText -Force
$cred=New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $GlobalAdmin, $SecurePass
                
$recipient="user@isp.com"
$subject="O365 services report for: "+$timestamp
$body="Please find your O365 sevices report for: "+$timestamp +" attached to this e-mail"
Send-MailMessage -To $recipient -from $globaladmin -Subject $subject -Body $body -BodyAsHtml -Attachments $file -SmtpServer smtp.office365.com -Port 587 -UseSsl -Credential $cred

#cleaning-up logs
#note: if you want to keep old reports, please comment the line below. The script will always send the lastest log. 
Remove-Item $file

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

# Required: An O365 Admin or an O365 partner (AOBO) with delegated admin rights on the tenant

# Throttle Limits: 25 requests/IP client/second, or 5 requests/user account/minute

.Synopsis

Gets office 365 events

.DESCRIPTION

Users the Office 365 API to get all tenant events - https://msdn.microsoft.com/en-us/library/office/dn776043(v=office.15).aspx

.EXAMPLE

get-O365Events

.EXAMPLE

get-O365Events -last 5

[Can add username in now]

get-O365Events -username email@address.com

function Get-O365Events

{

[CmdletBinding()]

[Alias()]

[OutputType([int])]

Param

(

# Param1 help description

[Parameter(Mandatory=$false,

ValueFromPipelineByPropertyName=$false,

Position=0)]

[int]$last = 0,

[string]$username

)

Begin

{

Try{

# Getting Tenant Credentials

#Get Credentials

#Read variables from console

$GlobalAdmin = "admin@tenant.onmicrosoft.com"

$GlobalAdminPassword = "yourpassword"

#Connecting

$SecurePass = ConvertTo-SecureString -string $GlobalAdminPassword -AsPlainText -Force

$cred=New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $GlobalAdmin, $SecurePass

$Json = (@{userName=$cred.username;password=$cred.GetNetworkCredential().password;} | convertto-json).tostring()

$cookie = (invoke-restmethod -contenttype "application/json" -method Post -uri "https://api.admin.microsoftonline.com/shdtenantcommunications.svc/Register" -body $json).RegistrationCookie

#We now need to obtain our authentication cookie by calling the Register method with our Office 365 username and password.

#The Register method will return a cookie which can be used to authenticate subsequent requests for up to 2 days. Each additional method will return

#an updated Cookie, which extends the life of the cookie for another 48 hours.

#The Service URL as per the MSDN documentation is "https://api.admin.microsoftonline.com/shdtenantcommunications.svc/".

#The Method that we are calling to obtain the cookie is the Register method.. To call this method, we add the method name to the URL, so that

#it is "https://api.admin.microsoftonline.com/shdtenantcommunications.svc/Register". We then invoke the web request with our username and password in JSON format

#The method will return several properties, one of which is our RegistrationCookie. We need to store this cookie for future API requests.

#preferredEventType -- "0" to represents a Service Incident, "1" to represent a Maintenance Event, and "2" to represent a Message Center communication

$load = (@{lastCookie=$cookie;locale="en-US";preferredEventTypes=@(0,1,2);} | convertto-json).tostring()

$events = (invoke-restmethod -contenttype "application/json" -method Post -uri "https://api.admin.microsoftonline.com/shdtenantcommunications.svc/GetEvents" -body $load)

}

Catch{

Write-Warning -Message "Please Check your credentials"; break

}

Finally{}

}

Process

{

$newEvent = foreach($evnt in $events.events){

New-Object psobject -Property @{

ID = $evnt.ID

Title = $evnt.Title

ServiceAftected = $evnt.AffectedServiceHealthStatus.servicename

Status = $evnt.Status

Time = $evnt.starttime

LastUpdated = $evnt.LastUpdatedTime

Message = $evnt.messages.messagetext

}

End

{

if($last -eq 0){$last = 10}

$newEvent| sort -property Time | select -Property Title,ServiceAftected,Status, Time,LastUpdated, message -Last $last | fl

}

#timestrapping log

$timestamp = get-date -format “yyyyMMdd_hhmmtt”

$filenameStart = “O365ServiceReport_for_”

#Note that the c:\O365R folder has to be present on the drive

cd c:\O365R\

$filepath = (“{0}{1}.csv” -f $filenamestart, $timestamp)

#Exporting to pre-defined folder

Get-O365Events |Out-File $filepath

#Defining logs folder and getting latest item

$logdir="C:\O365R"

$lastlog=Get-ChildItem $logdir | Sort-Object LastAccessTime -Descending |Select-Object -First 1

$file=$lastlog.name

#sending mail with last logs using O365 SMTP

$GlobalAdmin = "admin@tenant.onmicrosoft.com"

$GlobalAdminPassword = "yourpassword"

#Connecting

$SecurePass = ConvertTo-SecureString -string $GlobalAdminPassword -AsPlainText -Force

$cred=New-Object -TypeName System.Management.Automation.PSCredential -ArgumentList $GlobalAdmin, $SecurePass

$recipient="user@isp.com"

$subject="O365 services report for: "+$timestamp

$body="Please find your O365 sevices report for: "+$timestamp +" attached to this e-mail"

Send-MailMessage -To $recipient -from $globaladmin -Subject $subject -Body $body -BodyAsHtml -Attachments $file -SmtpServer smtp.office365.com -Port 587 -UseSsl -Credential $cred

#cleaning-up logs

#note: if you want to keep old reports, please comment the line below. The script will always send the lastest log.

Remove-Item $file

[…]