StoragePoint 6.4 - PowerShell and API Reference Guide

Set-EndPointCapacityMonitorJob

This command allows the Endpoint Capacity Monitor Job to run immediately or be scheduled. When run, it will check the status of the existing endpoints. The Endpoint Capacity Monitor job is scheduled to run every minute, by default.

Parameters

·RunEveryMinutes (runevery): A number between 1 and 59 that represents how often the timer job should be run.

·ScheduledTime : Set scheduled timeframe in format time. For example: “15:00-22:00”.

·JobServer (jobsrv): Server name to run the job.

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

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

·RunNow: If specified (-RunNow), then the job runs immediately. This setting ignores any scheduling options provided. This may be necessary to override current scheduled jobs.

·BringOfflineEndpointsOnline (bringonline): Yes will bring endpoints back online that were taken offline because they went over the free space threshold that was set in the endpoint section of StoragePoint.

Example

Example to run the job immediately.

Set-EndpointCapacityMonitorJob –RunNow

Set job Properties as RunEveryMinutes, ScheduleTime

Set-EndpointCapacityMonitorJob –runevery 45 –ScheduledTime “15:00-20:00”

Set job Properties as EmailDefault, NotificationEmailOther

Set-EndpointCapacityMonitorJob –RunEveryMinutes 45 –ScheduledTime “16:00-18:00” –NotificationEmailOther “test.example@dominio.com” –EmailDefault

Set job Properties as BringOfflineEndpointsOnline, JobServer

Set-EndpointCapacityMonitorJob –BringOnline “yes” –jobsrv “SERVERNAME”

Run Endpoint Capacity Monitor with email Default and Notification to additional contacts

Set-EndpointCapacityMonitorJob  –EmailDefault - NotificationEmailOther “test@dominio.com” -RunNow

Set-PerServerMaintenanceJob

This command schedules the StoragePoint Per Server Maintenance Job, which cleans up unused files from temp folders used by the servers in the SharePoint farm where StoragePoint is installed. It is scheduled to run hourly, by default. This command can be used to set which servers run the timer job.

Parameters

·ScheduleType: Designate the type of schedule. Allowable values: EveryMinute, Hourly, Daily, Weekly, Monthly.

·EveryMinute: used to indicate the number of minutes between runs. Values are a numeral with the value 1-59. Used with ScheduleType EveryMinute.

·StartMinuteHourly, -EndMinutehourly: Used to indicate the number of minutes past the top of the hour to start and stop, respectively, the Hourly timer job. Values are 1-59. Used with ScheduleType Hourly.

·JobStartDate, -JobEndDate: Used to indicate the start and stop times, respectively, of the Daily timer job. Values are represented by 24 hour format, "10:00", "15:00", etc. Used with -ScheduleType Daily. It is also used with -ScheduleType Weekly.

·BeginDayOfWeek, -EndDayOfWeek: Used to indicate the start and stop day of the week, respectively, of the Weekly timer job. Values are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday. Used with -ScheduleType Weekly.

·MonthlyEveryType: Day or date of the month to run the timer job. Values are Day or Date. Used with -ScheduleType Monthly

·StartingDayEveryMonth: Used with -MonthlyEveryType Date to say which day of the month (1-31) the job should start. Can be used with EndingDayEveryMonth.

·WeekEveryMonth: Used with -MonthlyEveryType Day, to indicate which occurrence (First, Second, Third, Fourth, or Last) of the day of the week to run the job.

Examples

Example to run the job every 45 minutes.

Set-PerServerMaintenanceJob -ScheduleType EveryMinute -EveryMinute 45

Example to run the job every hour at 45 minutes past the hour.

Set-PerServerMaintenanceJob -ScheduleType Hourly -StartMinuteHourly 45 -EndMinutehourly 55

Example to run the job daily between 3:00 PM and 8:00 PM.

Set-PerServerMaintenanceJob -ScheduleType Daily -JobStartDate "15:00" -JobEndDate "20:00"

Example to run the job weekly between Monday and Thursday.

Set-PerServerMaintenanceJob -ScheduleType Weekly -BeginDayOfWeek Monday -EndDayOfWeek Thursday -JobStartDate "12:00" -JobEndDate "15:00"

Example to run the job Monthly by Date of the month.

Set-PerServerMaintenanceJob -ScheduleType Monthly -MonthlyEveryType Date -StartingDayEveryMonth 5 -EndingDayEveryMonth 30 -JobStartDate "17:00" -JobEndDate "20:00"

Example to run the job Monthly by Day of the month, ie. every fourth Tuesday at 9 am.

Set-PerServerMaintenanceJob -ScheduleType Monthly -MonthlyEveryType Day  -BeginDayOfWeek Tuesday -WeekEveryMonth fourth -JobStartDate "9:00"

Timer Job Queuing Cmdlets

The StoragePoint cmdlet library includes a number of commands to queue the various StoragePoint timer jobs. The commands cover the BLOB Health Analyzer, Unused BLOB Cleanup, and Backup Synchronization 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 Colllection ID>'

[Target=Site (Web)]

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

[Target=List]

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

Add-STPBHAJobToQueue

This command puts the BLOB Health Analyzer Job into the StoragePoint Queue and returns the unique queue ID.

Parameters

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

·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 (-emailDefault): If specified, 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 (-emailOnErrorOnly): If specified, then send status email only if an error occurs when running the job.  

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

·JobScope (-js): See parameter definitions in Timer Job Scope Parameter.

·JobServer (-jobsrv): Server name to run the job.

Example

Add-BHAJobtoQueue -p MainProfile1 –ilf –js "wa:4ea5e602-8164-4e9a-a845-8d50eaca8054"

Result

The job queue '38' was queued.