StoragePoint 6.0 - PowerShell and API Reference Guide

Set-BackupSyncJob

This command schedules a backup Sync Job for a specified profile. This job backs up the endpoint(s) of the profile.

Parameters

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

·SchedType : The type of schedule to use when setting up this job. Valid values are OneTime, Minute, 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.

·Minutes: A number between 1 and 59 that represents how often the timer job should be run.

·JobStartDate (startdate): The start date/time. The time portion is used to set the start time for 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 Minute, Daily and Weekly jobs.

·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.

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

·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.

Example

This example schedules an backup sync Job to run immediately.

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

This examples sets the job up to run every 30 minutes

Set-BackupSyncJob –p MainProfile1 -schedtype minute -minutes 30

Set-ContentMigratorJob

This command allows the Content Migrator Job to run immediately or be scheduled. When run, it will move blobs to the endpoint as expected. The Content Migrator job is scheduled to run every 5 minutes, by default. This can be used to update various parameters.

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.

·NumberOfThreads (threads): Number of threads 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.

·JobRole: Values allowed: Controller, Standalone

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

·IncludeLargeFiles (ilf): Set the flag to include the large files options.

Example

Example to run the job immediately.

Set-ContentMigratorJob –RunNow

Set job Properties as RunEveryMinutes, ScheduleTime

Set-ContentMigratorJob –runevery 45 –scheduledtime “15:00-20:00” -ilf yes

Set job Properties as EmailDefault, threads, NotificationEmailOther

Set-ContentMigratorJob –jobsrv “SERVERNAME” –threads 15 –EmailDefault – NotificationEmailOther “test.example@dominio.com”

Set-ContentMigratorJob –jobsrv “SERVERNAME” –threads 15 –EmailDefault – NotificationEmailOther “test.example@dominio.com” -JobRole Controller

Run Content Migrator Job with additional Parameters

Set-ContentMigratorJob –jobsrv “SERVERNAME” –threads 15 –EmailDefault – NotificationEmailOther “test.example@dominio.com” -RunNow

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, threads, NotificationEmailOther

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

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"