The first post in the series is here.
(This is the last post in this series.)
The PST Utility Module is really just a collection of functions. Here's a list of the functions and short description of how they are used.
Get the module here.
Queue Processing:
These queue processing functions are used to do the work of Importing PST into Archive Mailboxes as well as maintenance of the queues.
Add-PSTIMportQueue
Given a user name, find their PST files, set up the job queues for the PST files, and notify the user and admin with an initial report. A more detailed explanation is here.
Process-PSTImportQueue
Loop through each job and take appropriate action until the job goes through all the stages of: Copied, Imported, Cleaned up, and Notified. A more detailed explanation is here.
Set-PSTImportQueue
Set different attributes on a user’s jobs, or a single job. A more detailed explanation is here.
Remove-PSTImportQueue
Remove a user or a job from the queue.
Report-PSTDiscovery
Finds all PST files for All Mailbox Users and tracks their usage – weekly run
Report-PSTOverallSummary
Generates a daily detailed report in an HTML file – also sends a summary report to the Admin and Boss.
Admin Functions:
These functions are meant for Admins to run. They can help the Admin decide how to process a user's PST files.
Check-ForPST
Same as the Get-PSTFileList above except input is geared to an Admin and not a Job Object
Get-ArchiveUserInfo
A quick report about a user, do they have an Archive mailbox already, GPO, etc
Get-ImportStatus
A quick way to check on import queues and suspend and restart, etc
A quick way to check on import queues and suspend and restart, etc
Move-PSTs
This checks for and moves a users PST file from the Home Share to their local PC
This checks for and moves a users PST file from the Home Share to their local PC
New-OnlineArchiveByUser
This adds the Archive Mailbox to a user, setting all the defaults. For people without PST files to import
This adds the Archive Mailbox to a user, setting all the defaults. For people without PST files to import
Optimize-PSTImportQueue
Sort Users by number of PST files, so the most number of users get done quickly
Sort Users by number of PST files, so the most number of users get done quickly
Helper Functions
Add-ToGPO
Add a user to a group we use to control Disallow PST Growth
Adjust-Quota
Sets quota to default for Online PST users
CC
Counts collections 0, 1, many
ConvertTo-ComputerName
Sets quota to default for Online PST users
CC
Counts collections 0, 1, many
ConvertTo-ComputerName
Returns the computername for an IP
ConvertTo-IP
Returns the IP for a given Comptername
Clean-OnlinePSTGPO
In our world, there is a distinct set of rules for the GPO, we check them here. Add people who are missing and remove people who should not be there.
Get-FreeDiskSpace
Returns the free space of a given computer drive – used when moving PST files back to a local computer.
Get-ClientAccessUserLog
Returns raw info on a user extracted from RPC logs on CAS servers
Get-MRSServer
Returns the MRS Server to use for this move
Get-OutlookEXEVersion
Returns the version of Outlook installed on a computer by looking at the EXE
Get-SingleMailboxObject
Returns a mailbox object, if results are anything other than a single entry, it returns nothing
ConvertTo-IP
Returns the IP for a given Comptername
Clean-OnlinePSTGPO
In our world, there is a distinct set of rules for the GPO, we check them here. Add people who are missing and remove people who should not be there.
Copy-PSTusingBITS
Uses BITS to copy the PST file to the share for processing. From PC’s and far away sites
Uses BITS to copy the PST file to the share for processing. From PC’s and far away sites
Copy-PSTtoImportShare
Uses copy-item to copy the PST file to the share for processing. Used for local AD site files
Uses copy-item to copy the PST file to the share for processing. Used for local AD site files
Format-JobStatus
Returns the job status based on user or overall
Returns the job status based on user or overall
Get-ISODayOfWeek
Returns the day of the week for a given date
Returns the day of the week for a given date
Get-FreeDiskSpace
Returns the free space of a given computer drive – used when moving PST files back to a local computer.
Get-ClientAccessUserLog
Returns raw info on a user extracted from RPC logs on CAS servers
Get-MRSServer
Returns the MRS Server to use for this move
Get-OutlookEXEVersion
Returns the version of Outlook installed on a computer by looking at the EXE
Get-SingleMailboxObject
Returns a mailbox object, if results are anything other than a single entry, it returns nothing
Get-PSTFileList
Return the PST file collection from Home Shares or PC or some directory
Return the PST file collection from Home Shares or PC or some directory
Get-ArchDB
Returns the best candidate mailbox database for the Import. By smallest mailbox database size.
Returns the best candidate mailbox database for the Import. By smallest mailbox database size.
isMemberof
Tests the membership of a group
Tests the membership of a group
Import-PSTFromShare
Starts the import process using the Job Object for settings
Starts the import process using the Job Object for settings
Lock-PSTIQ
Creates a zero length file to signal processing is happening
Creates a zero length file to signal processing is happening
Move-PSTToLocal
This moves a PST file from a Home Share to the local PC – if all test conditions are true
This moves a PST file from a Home Share to the local PC – if all test conditions are true
New-ArchPSTFileLogObject
Creates a new object for logging the PST file activity of Users with Archive Mailboxes
Creates a new object for logging the PST file activity of Users with Archive Mailboxes
New-ArchPSTIndex
Finds or creates a new Index entry for a PST file. Used to search the PST related Filelog Objects
New-PSTFileLogObject
Creates a new object for Logging all PST files for all users
New-PSTFileIndex
Finds or creates a new index entry for a PST file object for All Users
New-PSTJobObject
Creates the Job object used in PST import Jobs
New-PSTReportObject
Creates object used in PST Reporting
New-OnlineArchiveByJob
Gives the user an Archive Mailbox, using the Job Object passed. Only used in Add-PstImportQueue
Gives the user an Archive Mailbox, using the Job Object passed. Only used in Add-PstImportQueue
New-TargetPSTDirectory
Creates a new directory in the share using the User’s log in name
Creates a new directory in the share using the User’s log in name
Resets all Backup filenames to Now() using the Format ‘<filename>-yyyyMMddHHmmss.<ext.>’
Send-NotificationInitialReport
When add-pst is run, and discovers PST files to process, a summary is sent to the user.
Send-NotificationFinalReport
When processing is finished, the results are sent to the user.
Send-NotificationPSTRemoval
When reports are run, a message is sent to the user about still connected PST files (14 day cycle)
When add-pst is run, and discovers PST files to process, a summary is sent to the user.
Send-NotificationFinalReport
When processing is finished, the results are sent to the user.
Send-NotificationPSTRemoval
When reports are run, a message is sent to the user about still connected PST files (14 day cycle)
Test-OutlookClientVersion
A way to control what client version are accepted for import
A way to control what client version are accepted for import
Test-PSTIQLock
Test if the Queue is locked, returns true/false
Test if the Queue is locked, returns true/false
Unlock-PSTIQ
Removes the lock – when the processing pass is done
No comments:
Post a Comment