StoragePoint 6.4 - PowerShell and API Reference Guide

Add-STPUBCJobToQueue

This command puts the Unused BLOB Clean-up 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 removed by the unused BLOB cleanup job.  

·OnlyLargeFiles (-olf): Only large files will be analyzed and removed by the unused BLOB cleanup 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.  

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

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

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

Example

Add-UBCJobtoQueue -p MainProfile1 -ilf

Result

The job queue '39' was queued.

Add-STPBackupSyncJobToQueue

This command puts the Backup Sync 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

·JobRole (-jobRole): Values allowed: Controller, Standalone  

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

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

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

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

Example

Add-STPBackupSyncJobToQueue -p MainProfile1 -EmailDefault

Result

The job queue '40' was queued.

Get-STPQueueJobs

Returns jobs currently waiting in the queue, displaying the values for ‘Job Name’ and ‘State’.

Example

Get-STPQueueJobs

Result

STP Job Queue Id- 38

                                     Job Name: StoragePoint_Orphan_Blob_Cleanup_manual_<ProfileId>

                                     State: Waiting

STP Job Queue Id- 39

                                     Job Name: StoragePoint_Blob_Reference_Scan_manual_<ProfileId>

                                     State: Waiting

STP Job Queue Id- 40

                                     Job Name: StoragePoint_Backup_Sync_manual_<ProfileId>    

                                     State: Waiting

Get- STPQueueJobDetails

Returns StoragePoint job details according to the unique Number associated with enqueued job.

Parameters

·<unique Number associated with enqueued job>

Example

Get-STPQueueJobDetails 38

Result

STP Job Queue Id- 38

Job Name: StoragePoint_Blob_Reference_Scan_manual_<ProfileId>

State: Waiting

Job Id: 00000000-0000-0000-0000-000000000000

Job Type: BlobRefScan

Profile Id: <ProfileId>

Job Settings:

               NotificationEmailCondition: always

               ScanLargeFiles: True

               NotificationEmailOther:

               RepopulateIfMissing: False

               ScanOnlyLargeFiles: False

               NotificationEmailDefault: False

               Scope: wa:4ea5e602-8164-4e9a-a845-8d50eaca8054