Chat now with support

Get Live Help
Complete Registration

Sign In

Request Pricing

Contact Sales

StoragePoint 6.4 - PowerShell and API Reference Guide

Table of Contents

PowerShell Guide

StoragePoint PowerShell Overview Getting Started Profile and Endpoint Management Cmdlets

Add-Endpoint Add-Profile Add-EndpointToProfile Add-BackupEndpointToProfile Add-LibrarianConfig Set-ProfileEndPointSequence Set-ProfileArchiving Set-ArchiveRulesToProfile Set-RMToProfile Set-HMToProfile Get-EndpointExists Get-Endpoint Get-AllEndpoints Get-Profile Get-AllProfiles Get-AllEndpointsByProfile Get-DecryptUncompressBLOBFile Get-LibrarianConfig Set-EndpointConnection Set-SystemCacheConnection Remove-ProfileEndpoint Remove-Profile Remove-Endpoint Reset-DefaultValues

Timer Job Scheduling Cmdlets

Set-BLOBHealthAnalyzerJob Set-UnusedBLOBCleanupJob Set-BLOBExternalizationJob Set-BLOBRecallJob Set-BLOBMigrateJob Set-ArchivingAgingJob Set-ArchivingMetadataJob Set-MigrateRecordsJob Set-MigrateHoldsJob Set-BackupSyncJob Set-ContentMigratorJob Set-EndPointCapacityMonitorJob Set-PerServerMaintenanceJob

Timer Job Queuing Cmdlets

Add-STPBHAJobToQueue Add-STPUBCJobToQueue Add-STPBackupSyncJobToQueue Get-STPQueueJobs Get- STPQueueJobDetails Remove-STPQueueJob

BLOB Information and Migration Cmdlets

Get-AllBLOBs Move-BLOB Invoke-RecallItem Invoke-ExternalizeItem

Miscellaneous SharePoint Utility Cmdlets

Get-SiteCollectionId Get-ContentDBId Get-WebApplicationId Find-SharePointItem Set-LargeFileUpload

PowerShell Script Examples

Creating a Site Collection Profile with No Encryption or Compression Creating a Content Database Profile with Encryption and Compression Creating a Content Database Profile Using RBS Creating Multiple Profiles Using the Same Endpoint Creating a Profile with Asynchronous Endpoint Selection Displaying All Endpoints Meeting Certain Criteria Displaying All BLOB Files Associated with a SharePoint Document Enabling App Management service Application and App Catalog Altering MasterKey Encryption Password on Existing Profiles

StoragePoint API Reference

Using the API Objects in Visual Studio Profile Creation API

ProfileAPI Object Reference Profile Creation Code Examples

Archive API Object Reference Archive Rule Code Examples

Timer Job API Object Reference Timer Job API Object Reference Code Examples

TimerJobStatusAPI Reference - Content Migrator Example TimerJobStatusAPI Reference - Capacity Monitor Example

TimerJobStatusAPI

Timer Job Status API Object Reference Timer Job Status API Object Reference Code Examples

Blob Migration API

BlobAPI Object Reference BlobAPI Object Reference Code Examples

Blob Reference API

BlobReferenceAPI Object Reference BlobReferenceAPI Code Example

Upload Large File API

UploadLargeFileAPI Object Reference Upload Large File API Code Example

Validator API Examples

StoragePoint APIs in Visual Studio

Contacting Quest Technical Support Resources

Remove-STPQueueJob

Removes Queue job according queue job number and, if not started yet, the command returns the following message The job queue identifier 168 was successfully removed. 

Parameters

·<unique Number associated with enqueued job>

Example

Remove-STPQueueJob 40

Result

The job queue identifier 40 was successfully removed.

BLOB Information and Migration Cmdlets

The StoragePoint cmdlet library contains functions to query for BLOB file information and also to migrate individual BLOBs.

Get-AllBLOBs

This command returns a list of BLOB Reference objects based on a SharePoint CAML query run against a specific SharePoint document library.

Parameters

·SiteUrl (s): The URL of the SharePoint site with which a profile is associated. REQUIRED.

·List (l): The SharePoint document library to query.

·Query (q): The CAML query in order to find the needed BLOB reference(s).

Example

The following runs a CAML query, finding all documents that have a file name which contains "tif". The BLOB Reference objects for the results of the query will be returned in a list.

Get-AllBLOBs -s http://sharepoint/docs -l Shared Documents -q "<Where><Contains><FieldRef Name=FileLeafRef /><Value Type=File>tif</Value></Contains></Where>

Move-BLOB

This command migrates an externalized SharePoint documents BLOB to another endpoint.

Parameters

·DocUrl (doc): Absolute URL of the document BLOB to migrate. REQUIRED.

·EndpointId (ep): The Id (GUID) or name of the target endpoint. REQUIRED.

·IncludeVersions (iv): If specified (-IncludeVersions), command will migrate all versions of the document as well.

Example

The following example moves a BLOB to the endpoint MainEndpoint2.

Move-BLOB -doc http://sharepoint/docs/documents/123.tif -ep MainEndpoint2

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating

© 2024 Quest Software Inc. ALL RIGHTS RESERVED. Terms of Use Privacy Cookie Preference Center