StoragePoint 6.4 - PowerShell and API Reference Guide

Timer Job Scheduling Cmdlets

The StoragePoint cmdlet library includes a number of commands to schedule the various StoragePoint timer jobs. The commands cover the BLOB Health Analyzer, Unused BLOB Cleanup, Externalization, Recall, (Bulk) Migrate, Backup, Records & Holds, Aging, Versioning and Metadata archiving jobs.

Scope Parameter Definition

When selecting scopes for select timer jobs, the following format needs to be used for -JobScope. Not all parameters are available for all timer jobs.

[Target=WebApp]

-JobScope 'wa:<WebApp ID>'

[Target=CDB]

-JobScope 'wa:<WebApp ID>/cdb:<CDB ID>'

[Target=Site Collection]

-JobScope 'wa:<WebApp ID>/cdb:<CDB ID>/s:<Site Collection ID>'

[Target=Site (Web)]

-JobScope 'wa:<WebApp ID>/cdb:<CDB ID>/s:<Site Collection ID>/w:<site (Web) ID>'

[Target=List]

-JobScope 'wa:<WebApp ID>/cdb:<CDB ID>/s:<Site Collection ID>/w:<site (Web) ID>/l:<List ID>'

Set-BLOBHealthAnalyzerJob

This command schedules a BLOB Health Analyzer timer job. This timer job will analyze and optionally try to restore profile content. Analyzer will fix from the following:
 
- Missing BLOB files.
- Restore BLOBs if RepoulateIfMissing is used.
- BLOB references with mismatched size.
- BLNK (link) files with invalid content.
- BLNK files optimized and updated.
- Various system cache metrics.

Parameters

·Profile (p): The name or Id of the profile in which to run the job under. REQUIRED

·Type (schedtype): The type of schedule to use when setting up this job. Valid values are OneTime, Daily, and Weekly. If not specified, the timer job will run immediately.

·DayOfWeek (dow):  The day of the week to run the job when the schedule type is set to Weekly.

·JobStartDate (startdate): The start date/time. The time portion is used to set the start time for Daily and Weekly jobs.  It is required for updating existing Daily and Weekly jobs.

·JobEndDate (enddate):  The end date/time. Not used for OneTime jobs. The time portion is used to set the end time for Daily and Weekly jobs.  It is required for updating existing Daily and Weekly jobs.

·IncludeLargeFiles (ilf): If indicated, the Large File Uploads will also be included in the BHA job.

·OnlyLargeFiles (olf): if indicated, only Large File Uploads will be included in the BHA job.

·EmailDefault: If specified (-EmailDefault), send status email to the default notification group setup in General Settings.

·NotificationEmailOther (email): Other email addresses (not in default notification group) to send status emails to.

·RunNow: If specified (-RunNow), then run the job immediately. Ignores any scheduling options provided.

·EmailOnErrorOnly: If specified (-EmailOnErrorOnly), then send status email only if an error occurs when running the job.

·RepopulateIfMissing: Repopulates missing blobs, if available. Default is false. Set value to 1 to enable this feature, 0 to disable.

·JobScope: See parameter definitions in Timer Job Scope Parameter.

·JobServer (jobsrv): Server name to run the job. REQUIRED for scheduled jobs.

Example

This example schedules BLOB Health Analyzer job to run immediately.

Set-BlobHealthAnalyzerJob –p MainProfile1 –EmailDefault –RunNow

This example schedules BLOB Health Analyzer job to run weekly on Wednesday between 2 and 5 am..

Set-BlobHealthAnalyzerJob –p MainProfile1 -schedtype Weekly -dow Wednesday -startdate "08-15-15 2:00" -enddate "08-15-15 5:00" –EmailDefault

Set-UnusedBLOBCleanupJob

This command schedules an Unused BLOB clean-up job for a specified profile.

Parameters

·Profile (p): The name or Id of the profile in which to run the job under. REQUIRED.

·Type (schedtype): The type of schedule to use when setting up this job. Valid values are OneTime, Daily, and Weekly. If not specified, the timer job will run immediately.

·DayOfWeek (dow):  The day of the week to run the job when the schedule type is set to Weekly.

·JobStartDate (startdate): The start date/time. The time portion is used to set the start time for Daily and Weekly jobs. It is required for updating existing Daily and Weekly jobs.

·JobEndDate (enddate):  The end date/time. Not used for OneTime jobs. The time portion is used to set the end time for Daily and Weekly jobs. It is required for updating existing Daily and Weekly jobs.

·JobServer (jobsrv): Server name to run the job. REQUIRED for scheduled jobs.

·EndpointFilter (ef): Specify specific endpoints which the timer job should analyze.

·RunNow: If specified (-RunNow), then run the job immediately. Ignores any scheduling options provided.

·EmailDefault: If specified (-EmailDefault), send status email to the default notification group setup in General Settings.

·NotificationEmailOther (email): Other email addresses (not in default notification group) to send status emails to.

·EmailOnErrorOnly: If specified (-EmailOnErrorOnly), then send status email only if an error occurs when running the job.

·IncludeLargeFiles (ilf): If indicated, the Large File Uploads will also be removed by the unused BLOB cleanup job.

·OnlyLargeFiles (olf): Only large files will be analyzed and removed by the unused BLOB cleanup job.

·JobScope: See parameter definitions in Timer Job Scope Parameter.

Examples

The following example will run the Unused BLOB Cleanup Job immediately.

Set-UnusedBLOBCleanupJob -p MainProfile1 -RunNow

The following example schedules the job on a recurring weekly schedule, and includes large files.

Set-UnusedBLOBCleanupJob -p MainProfile1 -schedtype Weekly -dow Saturday -startdate “12/26/2009 3:00” –enddate “12/26/2009 6:00” –EmailDefault -email someone@example.com -IncludeLargeFiles

The following example runs the job immediately and has LIST scope.

Set-UnusedBLOBCleanupJob -p MainProfile1 -RunNow -JobScope 'wa:61993f69-a1fa-47ae-a037-f19bb65e1341/cdb:8e3b4665-672c-4655-a41b-861c8f4e86b5/s:054de887-db61-4407-8322-564531dbefc4/w:74b8d00f-f6f5-4233-b372-05a0f267533a/l:c4dfbdba-21c6-44d1-8e5e-41be2b11079f'

Set-BLOBExternalizationJob

This command schedules externalization job for a specified profile. The job may be run immediately (-RunNow) or at a specified date/time (-JobStartDate).

Parameters

·Profile (p): The name or Id of the profile in which to run the job under. REQUIRED.

·JobStartDate (startdate): The start date/time to run the job.

·NumberOfThreads (threads): Number of threads to run the job with.

·RunNow: If specified (-RunNow), then run the job immediately. Ignores any scheduling options provided.

·JobRole (JobServerRole): Values allowed: Controller, Standalone

·Workers (ws): Servers that will act in the worker role of a controller-worker configuration.

·EmailDefault: If specified (-EmailDefault), send status email to the default notification group setup in General Settings.

·NotificationEmailOther (email): Other email addresses (not in default notification group) to send status emails to.

·EmailOnErrorOnly: If specified (-EmailOnErrorOnly), then send status email only if an error occurs when running the job.

·JobScope: See parameter definitions in Timer Job Scope Parameter.

Example

This example schedules an externalization job to run immediately.

Set-BLOBExternalizationJob –p MainProfile1 –threads 20 –EmailDefault –RunNow