StoragePoint 6.0 - PowerShell and API Reference Guide

Set-HMToProfile

This command configures Hold Management rules for migrating BLOBs based on placing a file in a Hold. After these are configured, existing content can be migrated using Set-MigrateHoldsJob.

Parameters

·ProfileName (p): The Id or name of the profile. REQUIRED

·Enabled : True or false, to enable or disable holds management on the profile.

·Scope : The scope of the holds management rule. This cannot be broader than the scope of the profile. REQUIRED

owa:<Web Application Id>/cdb:<Content DB Id>/s:<site collection Id>

·OnHold : True or False, whether to migrate a BLOB when the item is put in a hold.

·OnHoldEndpoint : Name of the endpoint where BLOBs should be stored when placed in a hold.

·RemovedFromHold : True or False, whether to migrate the BLOB when the item is no longer in a hold.

·RemovedFromHoldEndpoint : Name of the endpoint where BLOBs should be stored when no longer in hold.

Examples

The following examples show how to enable and add Holds Management rules to a profile.

Set-HMToProfile -p "Main Profile" -Enabled:$true -Scope "cdb:c54827c2-ff44-4569-86c0-d15e348ac71c/s:2dac99fe-b477-451a-bb1e-8f5279694a7d" -OnHold:$true -OnHoldEndpoint "EP2" -RemovedFromHold:$true -RemovedFromHoldEndpoint "EP1"

Get-EndpointExists

Determines whether the specified endpoint exists.

Parameters

·EndpointId (ep):  The endpoint name or Id. REQUIRED.

Example

Get-EndpointExists -ep MainEndpoint1

Result

True if endpoint exists. False if not.

Get-Endpoint

This command will retrieve an endpoint object. An EndpointAPI object is returned. See the StoragePoint API Reference for more information on properties of this object.

Parameters

·Endpoint (ep): The name or Id of the endpoint to retrieve. REQUIRED.

Examples

This example will retrieve the endpoint object and list all properties of the object for viewing.

Get-Endpoint -ep MainEndpoint1

This example shows how to assign an Endpoint object to a variable within the PowerShell pipeline and then use this object later on in the script.

$endpoint = Get-Endpoint -ep MainEndpoint1

Add-EndpointToProfile –ep $endpoint.EndpointId.ToString() –p MainProfile1

Get-AllEndpoints

This command will retrieve all StoragePoint endpoints into a list and display all the properties of each endpoint found.

Example

Get-AllEndpoints

Result

EndpointId                : <GUID>

Name                        : MainEndpoint1

AdapterName                : FileSystem

Connection                :PATH=\\Server\blobShare;BUFFERSIZE=8192;SHREDONDELETE=False;

Foldering                        : True

FolderingLevel                : 5

StoreSourceMetadata        :

HandleMissingMetadata        :

IsNew                        : False

UseCompression                : False

UseEncryption                : False

EncryptionProviderId        :

EncryptionPassphrase        :

ProfileState                : 1