DataCore Cmdlet Reference Guide

Table of Contents

Activate-DcsLicense Add-DcsAccessToken Add-DcsAction
Add-DcsClient Add-DcsHostGroup Add-DcsHostToGroup
Add-DcsiSNSServer Add-DcsLogicalDisk Add-DcsLogMessage
Add-DcsPassthroughSnapshot Add-DcsPool Add-DcsPoolMember
Add-DcsRecordingPoint Add-DcsReplication Add-DcsReplicationConsistencyRollback
Add-DcsReplicationPartnerGroup Add-DcsRole Add-DcsRollback
Add-DcsServer Add-DcsSnapshot Add-DcsStorageProfile
Add-DcsTask Add-DcsTrigger Add-DcsUser
Add-DcsUserOwnership Add-DcsUserRole Add-DcsvCenter
Add-DcsvCenterDataStore Add-DcsVirtualDisk Add-DcsVirtualDiskFromTemplate
Add-DcsVirtualDiskFromVirtualDisk Add-DcsVirtualDiskGroup Add-DcsVirtualDiskMirror
Add-DcsVirtualDiskTemplate Add-DcsVirtualDiskToGroup Add-DcsVirtualLogicalUnit
Add-DcsWitness Backup-DcsConfiguration Cleanup-DcsServerFCPortDatabase
Clear-DcsAlert Clear-DcsLog Connect-DcsiSCSITarget
Connect-DcsServer ConvertTo-DcsDualVirtualDisk ConvertTo-DcsFullSnapshot
Disable-DcsDataProtection Disable-DcsReplicationTestMode Disable-DcsSequentialStorage
Disable-DcsServerWriteCache Disable-DcsTask Disable-DcsVirtualDiskAutoRecovery
Disconnect-DcsiSCSITarget Disconnect-DcsServer Enable-DcsDataProtection
Enable-DcsReplicationTestMode Enable-DcsSequentialStorage Enable-DcsServerWriteCache
Enable-DcsTask Enable-DcsVirtualDiskAutoRecovery Export-DcsObjectModel
Export-DcsReport Force-DcsVirtualDiskOnline Get-DcsAction
Get-DcsAlert Get-DcsAllocationMap Get-DcsBackUpFolder
Get-DcsChunkAllocation Get-DcsChunkAllocationMap Get-DcsChunkReclamationMap
Get-DcsClient Get-DcsClientPreferredServer Get-DcsConfigurationState
Get-DcsConnection Get-DcsDefaultConnection Get-DcsDiskPath
Get-DcsDistributionPlan Get-DcsHostGroup Get-DcsLogicalDisk
Get-DcsLogMessage Get-DcsLogStore Get-DcsMirror
Get-DcsMonitor Get-DcsMonitorTemplate Get-DcsObject
Get-DcsPerformanceCounter Get-DcsPhysicalDisk Get-DcsPhysicalDiskPath
Get-DcsPool Get-DcsPoolMember Get-DcsPort
Get-DcsPortConnection Get-DcsPurgePrerequisites Get-DcsRecordingEndpoint
Get-DcsRecordingInstance Get-DcsRecordingPerformance Get-DcsRecordingPerformanceDescription
Get-DcsRecordingPoint Get-DcsRecordingResolution Get-DcsRecordingServer
Get-DcsRecordingSession Get-DcsRecordingSessionObsolete Get-DcsRecordingStatistics
Get-DcsReplication Get-DcsReplicationBufferFolder Get-DcsReplicationConsistencyPoint
Get-DcsReplicationPartnerGroup Get-DcsReplicationTransferAddress Get-DcsRole
Get-DcsRollback Get-DcsRollbackGroup Get-DcsSCSIInquiryData
Get-DcsServer Get-DcsServerCacheSize Get-DcsServerGroup
Get-DcsServerTime Get-DcsSharedPhysicalDisk Get-DcsSharedPool
Get-DcsSMTPSettings Get-DcsSnapshot Get-DcsSnapshotGroup
Get-DcsSnapshotMapStore Get-DcsStorageProfile Get-DcsTargetDevice
Get-DcsTargetDomain Get-DcsTask Get-DcsTrigger
Get-DcsUser Get-DcsUserOwnership Get-DcsUserRole
Get-DcsUserRoleRelation Get-DcsvCenter Get-DcsVirtualDisk
Get-DcsVirtualDiskGroup Get-DcsVirtualDiskTemplate Get-DcsVirtualLogicalUnit
Get-DcsWitness Import-DcsPool Invoke-DcsTask
Invoke-DcsWitnessContact Move-DcsLogicalDisk Move-DcsVirtualDiskSource
Pause-DcsReplication Pause-DcsVirtualDiskRecovery Purge-DcsPoolMember
Register-DcsClientPort Remove-DcsAccessToken Remove-DcsAction
Remove-DcsClient Remove-DcsClientPort Remove-DcsHostFromGroup
Remove-DcsHostGroup Remove-DcsiSNSServer Remove-DcsLogicalDisk
Remove-DcsPool Remove-DcsPoolMember Remove-DcsRecordingPoint
Remove-DcsReplication Remove-DcsReplicationPartnerGroup Remove-DcsRole
Remove-DcsRollback Remove-DcsRollbackGroup Remove-DcsServer
Remove-DcsServerPort Remove-DcsSnapshot Remove-DcsSnapshotGroup
Remove-DcsStorageProfile Remove-DcsTask Remove-DcsTrigger
Remove-DcsUser Remove-DcsUserOwnership Remove-DcsUserRole
Remove-DcsvCenter Remove-DcsVirtualDisk Remove-DcsVirtualDiskFromGroup
Remove-DcsVirtualDiskGroup Remove-DcsVirtualDiskTemplate Remove-DcsVirtualLogicalUnit
Remove-DcsWitness Repair-DcsVirtualDisk Replace-DcsVirtualDiskSource
Reset-DcsLogStore Reset-DcsServerFCPortLinkErrorCounts Reset-DcsServerPort
Resume-DcsReplication Resume-DcsVirtualDiskRecovery Reverse-DcsReplication
Revert-DcsRollback Revert-DcsSnapshot Serve-DcsVirtualDisk
Set-DcsAccessTokenProperties Set-DcsBackUpFolder Set-DcsClientProperties
Set-DcsDataProtectionProperties Set-DcsDefaultConnection Set-DcsDiskPathPreference
Set-DcsHostGroupProperties Set-DcsHypervisorHost Set-DcsInitiatorNodeName
Set-DcsiSCSIInitiatorSecret Set-DcsLogicalDiskAccess Set-DcsLogStore
Set-DcsPhysicalDiskPathPreference Set-DcsPhysicalDiskProperties Set-DcsPoolMemberProperties
Set-DcsPoolMemberThreshold Set-DcsPoolProperties Set-DcsPoolThreshold
Set-DcsPortProperties Set-DcsRecordingEndpointProperties Set-DcsRecordingServer
Set-DcsReplicationBufferFolder Set-DcsReplicationCheckPoint Set-DcsReplicationConsistencyPoint
Set-DcsReplicationInitializationType Set-DcsReplicationPartnerGroupProperties Set-DcsReplicationSnapshot
Set-DcsReplicationTransferAddress Set-DcsRoleProperties Set-DcsRollbackProperties
Set-DcsSCSIInquiryData Set-DcsServerCacheSize Set-DcsServerGroupDefaultWitnessProperties
Set-DcsServerGroupProperties Set-DcsServerPortProperties Set-DcsServerPortThreshold
Set-DcsServerProperties Set-DcsServerThreshold Set-DcsSMTPSettings
Set-DcsSnapshotMapStore Set-DcsSnapshotPool Set-DcsSnapshotProperties
Set-DcsStorageProfileProperties Set-DcsTaskProperties Set-DcsUserProperties
Set-DcsvCenterMultipathPolicy Set-DcsvCenterProperties Set-DcsVirtualDiskGroupProperties
Set-DcsVirtualDiskProperties Set-DcsVirtualDiskScsiId Set-DcsVirtualDiskSize
Set-DcsVirtualDiskTemplateProperties Set-DcsVirtualDiskThreshold Set-DcsVirtualDiskWitnessProperties
Set-DcsVirtualLogicalUnitProperties Set-DcsWitnessProperties Split-DcsRollback
Split-DcsSnapshot Split-DcsVirtualDisk Start-DcsDistributionPlan
Start-DcsHistoricalRecording Start-DcsRecording Start-DcsRecordingSession
Start-DcsReplicationOfflineInitialization Start-DcsServer Start-DcsVirtualDiskReclamation
Stop-DcsDeactivateReplication Stop-DcsDeleteReplication Stop-DcsHistoricalRecording
Stop-DcsMoveLogicalDisk Stop-DcsMoveStorageSource Stop-DcsRecording
Stop-DcsRecordingSession Stop-DcsReplicationOfflineInitialization Stop-DcsServer
Stop-DcsSnapshotOperation Stop-DcsSupportBundle Stop-DcsTask
Stop-DcsVirtualDiskReclamation Sync-DcsConfiguration Test-DcsRecordingEndpointConnection
Test-DcsRecordingServerConnection Test-DcsSupportBundleRelayAddress Unlock-DcsPhysicalDisk
Unserve-DcsVirtualDisk Update-DcsServerPort Update-DcsSnapshot
Upload-DcsSupportBundle

To Table of Contents

NAME

Activate-DcsLicense

SYNOPSIS

Activates license keys for non-trial licenses.

SYNTAX

Activate-DcsLicense   -Server <Object>   -ServerKey <String>   -CompanyName <String>   -ContactName <String>   -EmailAddress <String>   -PhoneNumber <String>   [ -Accept]   [ -LicenseServer <String> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]   [ -WhatIf]   [ -Confirm]

Activate-DcsLicense   -GroupKey <String>   [ -Capacity <String> ]   -CompanyName <String>   -ContactName <String>   -EmailAddress <String>   -PhoneNumber <String>   [ -Accept]   [ -LicenseServer <String> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]   [ -WhatIf]   [ -Confirm]

DESCRIPTION

Activates license keys for non-trial licenses. The cmdlet must be invoked separately to activate server keys, and again for group keys.

PARAMETERS

-Server<Object>
ServerHostData object, computer name, or ID that identifies the server. The computer name must be unique or the name must be fully qualified.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-ServerKey<String>
The license key to apply to a particular server. The format consists of five groups of five alphanumeric characters separated by hyphens, for instance "ABC1D-E23F4-5GHIJ6-LM78N-ABCDE".

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-CompanyName<String>
Name of the company.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-ContactName<String>
Name of the person designated to communicate with DataCore Technical Support.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-EmailAddress<String>
Email address of the contact. A valid format would be "contactname@yourcompany.com".

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PhoneNumber<String>
The phone number of the contact. The valid format includes the area code and hyphens, such as "555-555-5555".

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Accept<SwitchParameter>
Specify this parameter to accept the license term agreements without user interaction when invoking this cmdlet.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-LicenseServer<String>
This parameter is included as a diagnostic tool for DataCore Technical Support only. Do not use this parameter when invoking the cmdlet.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-WhatIf<SwitchParameter>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Confirm<SwitchParameter>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-GroupKey<String>
The license key to apply to the server group. The format consists of five groups of five alphanumeric characters separated by hyphens, for instance "ABC1D-E23F4-5GHIJ6-LM78N-ABCDE".

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Capacity<String>
The amount of licensed storage capacity to activate for the group. Use this parameter to activate a portion of the total licensed storage capacity. For instance, if the total licensed capacity is 100 TB, to activate 50 TB of that total capacity, enter "50 TB". The amount must be designated in terabytes.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

ServerHostData : Object that identifies the server.

OUTPUTS

NOTES

EXAMPLES

-------------- Example 1 Activates server key --------------

$servers = Get-DcsServer

Activate-DcsLicense -Server $servers[1].id -ServerKey XXXXX-XXXXX-XXXXX-XXXXX-XXXXX -CompanyName "Acme Data Storage Co." -ContactName "Sam Administrati" -EmailAddress SANman@acme.com -PhoneNumber 555-555-1212 -Accept

Activates a server key for the server group. Company and contact information is provided using parameters. The license term agreement is accepted. The server id is previously acquired with Get-DcsServer and stored in the variable $servers.


-------------- Example 2 Activates a group capacity key --------------

Activate-DcsLicense -GroupKey XXXX1-XXXX1-XXXX1-XXXX1-XXXX1 -Capacity "50 TB" -CompanyName "Acme Data Storage Co." -ContactName "Sam Administrati" -EmailAddress SANman@acme.com -PhoneNumber 555-555-1212 -Accept

Activates a server group key for licensed storage capacity. A portion of the total licensed capacity ("50 TB") is activated by using the parameter Capacity. Company and contact information is provided using parameters. The license term agreement is accepted.


To Table of Contents

NAME

Add-DcsAccessToken

SYNOPSIS

Creates an access token for an iSCSI target port to authenticate communication from the designated initiator port.

SYNTAX

Add-DcsAccessToken   [ -Server <String> ]   -Port <Object>   -InitiatorNodeName <String>   -TargetPassword <String>   -TargetUser <String>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsAccessToken   [ -Server <String> ]   -Port <Object>   -InitiatorNodeName <String>   -InitiatorPassword <String>   [ -InitiatorUser <String> ]   -TargetPassword <String>   -TargetUser <String>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Creates an access token for an iSCSI target port to authenticate communication from the designated initiator port. The access token will be created using CHAP authentication. When using mutual authentication, set the initiator secret before creating an access token for target secrets, see Set-DcsiSCSIInitiatorSecret. Before creating an access token for target secrets, the target should be logged out, see Disconnect-DcsiSCSITarget.

PARAMETERS

-Server<String>
Computer name or ID of the server. The computer name must be unique or the name must be fully qualified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Port<Object>
The name or ID of the iSCSI target port. In order to uniquely identify the port by name, the server must be specified.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-InitiatorNodeName<String>
Name of the initiator node that will be used in the session.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-TargetPassword<String>
Secret of the iSCSI target port. Secrets are 12-16 characters. Use caution when entering the secret, it will appear as typed on the display.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-TargetUser<String>
User Name for the iSCSI target port.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-InitiatorPassword<String>
Secret for the iSCSI initiator port. Secrets are 12-16 characters. This parameter value should be specified if using Mutual Authentication.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-InitiatorUser<String>
User name of the Microsoft iSCSI Initiator port. This parameter value should be specified if using Mutual Authentication.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

ServerScsiPortData : Object that identifies and describes the port.

NOTES

Also see Remove-DcsAccessToken, Set-DcsAccessTokenProperties, Set-DcsiSCSIInitiatorSecret.

EXAMPLES

-------------- Example 1 Adds access token for Mutual Authentication --------------

Add-DcsAccessToken -Server SSV1 -Port "Server iSCSI Port 1" -InitiatorNodeName "Microsoft iSCSI Initiator" -InitiatorPassword initsecret12 -InitiatorUser inithandshk -TargetPassword targetsecret1 -TargetUser targethandshk

Creates an access token for the port named "Server iSCSI Port 1" on the server named "SSV1" with target and initiator CHAP settings for mutual authentication.

IdInfo : DataCore.Executive.iSCSI.iScsiPortIdInfo
PortConfigInfo : DataCore.Executive.iSCSI.PortConfigInfo
IScsiPortStateInfo : DataCore.Executive.iSCSI.iScsiPortStateInfo
iSCSINodes : {iqn.1991-05.com.microsoft:ssv2.datacoresoftware.com}
CapabilityInfo : DataCore.Executive.iSCSI.iScsiPortCapabilityInfo
PresenceStatus : Present
PhysicalName : MAC:00-15-5D-11-E9-0F
ServerPortProperties : DataCore.Executive.ServeriScsiPortPropertiesData
RoleCapability : Frontend, Mirror
PortName : iqn.2000-08.com.datacore:ssv1-1
Alias : Server iSCSI Port 1
Description :
PortType : iSCSI
PortMode : Target
HostId : 74EDD1B3-6682-46A7-943C-2F0168CEC699
Connected : True
Id : 74EDD1B3-6682-46A7-943C-2F0168CEC699:MAC:00-15-5D-11-E9-0F
Caption : Server iSCSI Port 1
ExtendedCaption : Server iSCSI Port 1 on SSV1
Internal : False
     

To Table of Contents

NAME

Add-DcsAction

SYNOPSIS

Creates an action for the specified task.

SYNTAX

Add-DcsAction   -Task <Object>   -FilePath <String>   -Server <String>   -ScriptAction <String>   [ -ScriptParams <String> ]   [ -AppendTriggerStates <Boolean> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsAction   -Task <Object>   -LogLevel <String>   [ -PostAlert]   -Message <String>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsAction   -Task <Object>   -Recipient <String>   [ -CustomMessage <String> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsAction   -Task <Object>   -TargetId <String>   -MethodActionType <String>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Creates an action for the specified task. A parameter set is provided for each of the following function types: a scripting action, a logging action, sending an email, or performing a specific operation on an object (see MethodActionType parameter). One action can be added to the task for each invocation of the cmdlet.

PARAMETERS

-Task<Object>
TaskData object, ID, or name of the task to assign the created action to.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-FilePath<String>
The complete path to the script file or other executable file to be run as an action. The ScriptAction parameter must also be specified.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Server<String>
Computer name or ID of the server. The computer name must be unique or the name must be fully qualified.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-ScriptAction<String>
Designates the type of scripting function for the action. Possible values are "PowerShell" or "General". See example 2.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-ScriptParams<String>
Script parameters to be used with the script action. Multiple parameters and the associated values, or parameter arrays can be input, for example "-param1 value1 -param2 value2" or "-paramarray value1, value2, value3". Values without parameter names can also be input, for example "value1, value2, value3". See example 2.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-AppendTriggerStates<Boolean>
Use this parameter to append the trigger state data for the active triggers in a task. This parameter is only valid when running a script action. The trigger state data is appended to the script and can be accessed from the script, not returned in the TaskActionData object. Specify $true to append the trigger state data in the script. The data returned from the script will depend on the type of triggers that are configured for the task. Data will be returned in an array of objects called "TriggerState". Data from the trigger states can be compared using other cmdlets to obtain additional information. For instance, if the trigger was a monitor trigger, a “MonitorTriggerState” object will be appended with the following fields: MonitoredObjectId, TriggerType, TriggerTime, Caption, and ManualInvocation. The MonitoredObjectId in the object can be used to resolve the exact object that caused the monitor state to trigger the action. Another example, if a checkpoint trigger is configured, the "CheckpointTriggerState object will be appended with the following fields: VirtualDiskId, TriggerType, TriggerTime, Caption, and ManualInvocation. The VirtualDiskID can be used to resolve the exact object that received the checkpoint marker. Data can be output from the script file or used in the script to invoke other cmdlets. See Example 2 for more information.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-LogLevel<String>
The type of message to post in the event log if a messaging function is required. Possible values are: "Trace", "Info", "Warning", or "Error".

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PostAlert<SwitchParameter>
Specify this parameter to cause the event log message to also post an alert.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Message<String>
The message text to post to the event log for a log message action.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Recipient<String>
The name of the user to receive the email message. The user must have an email address specified in the user properties (see Add-DcsUser) and mail server information must be set (see Set-DcsSmtpSettings). To send a custom message in the email, use the -CustomMessage parameter in this cmdlet.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-CustomMessage<String>
The custom message text to include with an email action.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-TargetId<String>
ID of the target object associated with the MethodActionType parameter. If MethodActionType is "UpdateSnapshot" specify the ID of the snapshot in the TargetId parameter. If MethodActionType is "UpdateSnapshotGroup" specify the ID of the snapshot group in the TargetId parameter. If MethodActionType is "RevertSnapshot" specify the ID of the snapshot in the TargetId parameter. If MethodActionType is "RevertSnapshotGroup" specify the ID of the snapshot group in the TargetId parameter. If MethodActionType is "StartReclamation" specify the ID of the virtual disk in the TargetId parameter. If MethodActionType is "SendCheckpoint" specify the ID of the replication destination virtual disk in the TargetId parameter.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-MethodActionType<String>
Indicates which operation will be performed on the object indicated by the TargetId parameter. Specify one of the following values: "UpdateSnapshot" causes a snapshot to be updated with the latest changes on the source virtual disk. "UpdateSnapshotGroup" causes a snapshot group to be updated with the latest changes on the source virtual disks in the snapshot group. "RevertSnapshot" causes the virtual disk source to be reverted to the current state of the snapshot image. "RevertSnapshotGroup" causes the virtual disk sources in the snapshot group to be reverted to the current state of the snapshot images in the snapshot group. "StartReclamation" causes any SAUs comprised of all zeros on a virtual disk to be de-allocated and returned as available space in the pool. "SendCheckpoint" causes a checkpoint marker to be sent to the replication destination virtual disk.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

TaskData : Object that identifies the task.

OUTPUTS

TaskActionData : Object that identifies and describes the task action.

NOTES

Also see Remove-DcsAction, Get-DcsAction, Get-DcsTask.

EXAMPLES

-------------- Example 1 Adds an action to start virtual disk reclamation --------------

Add-DcsAction -Task MyNightlyTask -TargetId 
(Get-DcsVirtualDisk | where{$_.Caption -eq 'VDisk3'}).Id -MethodActionType StartReclamation

Adds an action for the task named "MyNightlyTask". The action is "StartReclamation" on the virtual disk named "VDisk3". Note the Virtual Disk Id is required, so is obtained programatically using the Get-DcsVirtualDisk cmdlet.

TargetId : bc1d2b2d679145698e2029415ea86724
MethodType : StartReclamation
TaskId : e0b61456-55b1-4f09-9567-39586e71ef16
Type : InvokeMethod
Id : 29359072-bf3e-4cd2-aab5-18c0056e688b
Caption : Initiates space reclamation on VDisk3
ExtendedCaption :
Internal : False
     

-------------- Example 2 Adds an action that runs a PowerShell script with parameters and appends trigger states in the script --------------

Get-DcsTask -Task Task1 | Add-DcsAction -Server SSV1 -ScriptAction PowerShell -FilePath C:\Test.ps1 -ScriptParams "-param1 Value1 -paramarray ArrayValue1, ArrayValue2, ArrayValue3" -AppendTriggerStates $true

The cmdlet Get-DcsTask is invoked to return the TaskData object for the task named Task1. The object is piped to the cmdlet Add-DcsAction to add a script action for the PowerShell script named "Test.ps1" which resides in the file path "C:\". The script will run with the parameter values "-param1 Value1 -paramarray ArrayValue1, ArrayValue2, ArrayValue3" on the server named "SSV1". The active trigger states for the task are appended to the script.

Import-Module ".\Datacore.Executive.cmdlets.dll"
                                

To Table of Contents

NAME

Add-DcsClient

SYNOPSIS

Adds a client (host) to a server group configuration.

SYNTAX

Add-DcsClient   -Name <String>   [ -Description <String> ]   [ -ClientType <String> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsClient   -Name <String>   [ -PreferredServer <Object[]> ]   [ -Description <String> ]   [ -ClientType <String> ]   -Multipath <Boolean>   -ALUA <Boolean>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Adds a client (host) to a server group configuration. Preferred servers can also be assigned, and MPIO and ALUA settings can be configured. After adding the client, ports can be assigned, see Register-DcsClientPort. See Set-DcsClientProperties to change properties.

PARAMETERS

-Name<String>
Name of the client to add.

Required: true
Position: 1
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Description<String>
Description of the client host.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-ClientType<String>
The operating system of the client. If this parameter is not specified, the default value of "WindowsServer2012" will be assigned. Values include: "WindowsServer2012" if the client host is running Windows Server 2012 and later. "WindowsServer2008" if the client host is running Windows Server 2008. "Windows" if the client host is running any Windows operating system version prior to Windows Server 2008. "Esx" if the client host is running VMware ESX. "CitrixXenServer" if the client host is running Citrix Xen Server. "SuseEnterpriseLinusServer11" if the client host is running Linux Suse Enterprise Server 11. "Linux" if the client host is running any Linux operating system other than Linux Suse Enterprise Server 11. "AixMpio" if the client host is running IBM AIX Native MPIO Legacy. "AixMpioTL6Plus" if the client host is running IBM AIX. "HPUX" if the client is running HP HPUX. "SolarisSanFoundation" if the client host is running Oracle (Sun) Solaris. "Other" if the client host is running an operating system that is not listed.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PreferredServer<Object[]>
Computer name or ID of one or more servers that should be preferred to handle I/O requests from the client (host). The computer names must be either unique or fully qualified. Multiple servers should be separated by commas, for instance "SSVVM01", "SSVVM02", "SSVVM03". MPIO and ALUA must be enabled. The Auto Select option (available in the console) is not supported in this cmdlet. If this parameter is not specified, the preferred server will be automatically selected when a mirrored virtual disk is created, the server with the first storage source is designated as the preferred server. See Add-DcsVirtualDisk and refer to the FirstServer parameter.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Multipath<Boolean>
Specify $true to enable multipathing support, or $false to disable multipathing support.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-ALUA<Boolean>
Specify $true to enable ALUA support, or $false to disable ALUA. Multipathing support must be enabled in order to enable ALUA support.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

ClientHostData : Object that identifies and describes the client host.

NOTES

Also see Register-DcsClientPort, Set-DcsClientProperties, Get-DcsClient, Remove-DcsClient.

EXAMPLES

-------------- Example 1 Adds a host to the server group configuration --------------

Add-DcsClient -Name ExchSrv1 -Description "MainLab_ExchangeServer" -ClientType "WindowsServer2012" -PreferredServer "BlazeSSV1", "BlazeSSV2" -Multipath $true -ALUA $true

Adds a Host named "ExchSrv1", provides a description, sets the operating system as "Microsoft Windows 2012", and sets the preferred servers as "BlazeSSV1" and "BlazeSSV2", and enables multipathing and ALUA support for the host. The default connection is used.

HostGroupId :
Type : WindowsServer2012
State : Unknown
AluaSupport : True
PathPolicy : PreferredServer
Description : MainLab_ExchangeServer
HostName : ExchSrv1
MpioCapable : True
SequenceNumber : 1086846
Id : 586dfb8e7ff845be986511a95491a74d
Caption : ExchSrv1
ExtendedCaption : ExchSrv1
Internal : False
     

To Table of Contents

NAME

Add-DcsHostGroup

SYNOPSIS

Creates a host group.

SYNTAX

Add-DcsHostGroup   -Name <String>   [ -Description <String> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Creates a host group. After creating the group, add hosts to the group, see Add-DcsHosttoGroup.

PARAMETERS

-Name<String>
Name of the Host Group to create.

Required: true
Position: 1
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Description<String>
Description of the host group.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

string : Name of host group.

OUTPUTS

HostGroupData : The object that identifies and describes the host group.

NOTES

Also see Add-DcsHostToGroup, Get-DcsHostGroup, Remove-DcsHostGroup, Remove-DcsHostFromGroup, Set-DcsHostGroupProperties.

EXAMPLES

-------------- Example 1 Create a host group. --------------

Add-DcsHostGroup -Name FinanceGroup1 -Description "A collection of hosts that serve the Finance Department for Region 1."

A host group named "FinanceGroup1" is created in the server group of the default connection. A description of the host group is also provided.

Alias : FinanceGroup1
Description : A collection of hosts that serve the Finance Department for Region 1.
SequenceNumber : 3200
Id : {9c1ea090-8af9-4207-93af-0864e2d99a94}
Caption : FinanceGroup1
ExtendedCaption : FinanceGroup1
Internal : False
     

To Table of Contents

NAME

Add-DcsHostToGroup

SYNOPSIS

Adds a client (host) to an existing host group.

SYNTAX

Add-DcsHostToGroup   -Group <String>   -Client <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Adds a client (host) to an existing host group.

PARAMETERS

-Group<String>
Name of the host group to add the clients to.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Client<Object>
ClientHostData object, name, or ID that identifies the client to add to the host group.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

ClientHostData : Object that identifies and describes the client host.

OUTPUTS

ClientHostData : Object that identifies and describes the client host.

NOTES

Also see: Add-DcsHostGroup, Get-DcsHostGroup, Remove-DcsHostGroup, Remove-DcsHostFromGroup, Set-DcsHostGroupProperties.

EXAMPLES

-------------- Example 1 Adds a single client to the group using the name of the client. --------------

Add-DcsHostToGroup -Group "FinanceGroup1" -Client "HostVM1"

The client named "HostVM1" is added to the host group named "FinanceGroup1".

HostGroupId : {9c1ea090-8af9-4207-93af-0864e2d99a94}
Type : WindowsServer2008
State : PortsConnected
MpioCapable : True
AluaSupport : False
PathPolicy : PreferredServer
PreferredServerId :
Description :
HostName : HostVM1
SequenceNumber : 3236
Id : 79ad9e209d68427c97edb01b6aa56e35
Caption : HostVM1
ExtendedCaption : HostVM1
Internal : False
     

-------------- Example 2 Adds all clients to a host group by passing objects. --------------

Get-DcsClient | Add-DcsHostToGroup -Group "HostGroup1"

The cmdlet Get-DcsClient is invoked to obtain the ClientHostData objects for all clients in the default connection of the server group. The objects are piped to the cmdlet Add-DcsHostToGroup to add all clients to the host group named "HostGroup1". The ClientHostData objects for the two clients are returned.

HostGroupId : {c45a88ba-fb29-4e7f-b607-02e29dceb166}
Type : WindowsServer2008
State : PortsConnected
MpioCapable : True
AluaSupport : False
PathPolicy : PreferredServer
PreferredServerId :
Description :
HostName : HostVM1
SequenceNumber : 4571
Id : 79ad9e209d68427c97edb01b6aa56e35
Caption : HostVM1
ExtendedCaption : HostVM1
Internal : False
     
HostGroupId : {c45a88ba-fb29-4e7f-b607-02e29dceb166}
Type : WindowsServer2008
State : PortsConnected
MpioCapable : True
AluaSupport : False
PathPolicy : PreferredServer
PreferredServerId :
Description :
HostName : HostVM2
SequenceNumber : 4573
Id : 4e18b7c089c94eda802f689cd253f80a
Caption : HostVM2
ExtendedCaption : HostVM2
Internal : False
     

To Table of Contents

NAME

Add-DcsiSNSServer

SYNOPSIS

Registers a Microsoft iSCSI Initiator port with an iSNS server.

SYNTAX

Add-DcsiSNSServer   [ -Server <String> ]   -Port <Object>   -Address <String>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Registers a Microsoft iSCSI Initiator port with an iSNS server. Also see Set-DcsServerPortProperties to configure iSNS on target ports.

PARAMETERS

-Server<String>
Computer name or ID of the server. The computer name must be unique or the name must be fully qualified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Port<Object>
ScsiPortData object, name, ID, or IP address that identifies the initiator port. To uniquely identify a port by name, the server must be specified.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Address<String>
Name or IP address of the iSNS server.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

ServerMSiScsiInitiatorData : Object that identifies the Microsoft iSCSI Initiator.

NOTES

Also see Set-DcsServerPortProperties.

EXAMPLES

-------------- Example 1 Registers an intiator port to an iSNS server --------------

Add-DcsiSNSServer -Port "Microsoft iSCSI Initiator on SSV1" -Address 13.0.0.13

Registers the initiator port named "Microsoft iSCSI Initiator on SSV1" with the iSNS Server at address 13.0.0.13.

InitiatorPortals : {fe80::ac9f:4abc:8e7:447a, fe80::2de4:e3b4:87d0:b299, fe80::f13e:c21d:f0b8:c2e, fe80::d86e:28b1:6c8e:ee36...}
iSnsServer : {13.0.0.13}
TargetPortals : {DataCore.Executive.iScsiTargetPortalData, DataCore.Executive.iScsiTargetPortalData, DataCore.Executive.iScsiTargetPortalData, DataCore.Executive.iScsiTargetPortalData...}
PresenceStatus : Present
PhysicalName : MSFT-05-1991
ServerPortProperties : DataCore.Executive.ServerPortPropertiesData
RoleCapability : Backend, Mirror
PortName : ssv1msiscsiinitiator
Alias : Microsoft iSCSI Initiator
Description :
PortType : iSCSI
PortMode : Initiator
HostId : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3
Connected : True
Id : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3:MSFT-05-1991
Caption : Microsoft iSCSI Initiator
ExtendedCaption : Microsoft iSCSI Initiator on SSV1
Internal : False
     

To Table of Contents

NAME

Add-DcsLogicalDisk

SYNOPSIS

Creates a logical disk from a pool or a pass-through disk on a server.

SYNTAX

Add-DcsLogicalDisk   [ -Server <String> ]   -Pool <String>   [ -ReservedSpace <String> ]   [ -Count <UInt32> ]   [ -SectorSize <DataSize> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsLogicalDisk   [ -Server <String> ]   -PassThroughDisk <String>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Creates a logical disk from a pool or a pass-through disk on a server. Multiple logical disks can be created if the source is from a pool. Logical disks can be used when creating virtual disks (see Add-DcsVirtualDisk).

PARAMETERS

-Server<String>
Computer name or ID of the server. The computer name must be unique or the name must be fully qualified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Pool<String>
Name or ID of the pool if used as the storage source of the logical disk. To resolve by name, the name must be unique to the server group or the server must be specified.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-ReservedSpace<String>
The amount of space reserved in a pool for exclusive use by the logical disk. This space must be free in the pool. Valid values consist of the number followed by the unit of measurement (MB, GB, TB). Decimals may be used. For example, "100GB", "1.5TB", and "500000MB" are valid sizes. Size can range from a minimum of 1GB to the size of the virtual disk.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Count<UInt32>
The number of logical disks to create from a pool. If not specified, one logical disk will be created.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-SectorSize<DataSize>
The sector size of the logical disk. Valid values are "512", "512B", "4096", or "4KB". If the unit is not included, it is assumed to represent the number of bytes in the sector. If this parameter is not specified, the sector size of the disk pool will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PassThroughDisk<String>
Physical disk name or ID of the pass-through disk if used as the storage source of the logical disk. To resolve by name, the name must be unique to the server group or the server must be specified.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

INPUTS

OUTPUTS

LogicalDiskData : Object the identifies and describes the logical disk.

NOTES

Also see Add-DcsVirtualDisk, Get-DcsLogicalDisk, Remove-DcsLogicalDisk.

EXAMPLES

-------------- Example 1 Adds logical disk from pool --------------

Add-DcsLogicalDisk -Server SSV1 -Pool "Disk pool 1" -ReservedSpace 10GB -Count 3

Creates three logical disks from the pool named "Disk pool 1" on the server named "SSV1", each having 10GB of reserved space in the pool. The server is identified to resolve the disk pool name.

StreamDiskId :
RetentionTime : 0
StreamSize : 0.00 B
StreamState : NotPresent
PoolId : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3:{ea7c7a80-bdf3-11e0-8304-00155d11e921}
VolumeIndex : 1
MinQuota : 10.00 GB
MaxQuota : 0.00 B
TierAffinity :
StorageName :
InReclamation : False
DataStatus : Undefined
PresenceStatus : Present
Size : 1.00 PB
SectorSize : 512 B
Description :
DiskStatus : Online
Virtualized : False
ClientAccessRights : NotDefined
Failure : Undefined
VirtualDiskId :
DiskRole : Unknown
ServerHostId : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3
IsMapped : False
Protected : False
Id : LD:A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3_V.{ea7c7a80-bdf3-11e0-8304-00155d11e921}-00000001
Caption : Storage source from Disk pool 1 on SSV1
ExtendedCaption : Storage source from Disk pool 1 on SSV1
Internal : False
     
StreamDiskId :
RetentionTime : 0
StreamSize : 0.00 B
StreamState : NotPresent
PoolId : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3:{ea7c7a80-bdf3-11e0-8304-00155d11e921}
VolumeIndex : 2
MinQuota : 10.00 GB
MaxQuota : 0.00 B
TierAffinity :
StorageName :
InReclamation : False
DataStatus : Undefined
PresenceStatus : Present
Size : 1.00 PB
SectorSize : 512 B
Description :
DiskStatus : Online
Virtualized : False
ClientAccessRights : NotDefined
Failure : Undefined
VirtualDiskId :
DiskRole : Unknown
ServerHostId : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3
IsMapped : False
Protected : False
Id : LD:A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3_V.{ea7c7a80-bdf3-11e0-8304-00155d11e921}-00000002
Caption : Storage source from Disk pool 1 on SSV1
ExtendedCaption : Storage source from Disk pool 1 on SSV1
Internal : False
     
StreamDiskId :
RetentionTime : 0
StreamSize : 0.00 B
StreamState : NotPresent
PoolId : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3:{ea7c7a80-bdf3-11e0-8304-00155d11e921}
VolumeIndex : 3
MinQuota : 10.00 GB
MaxQuota : 0.00 B
TierAffinity :
StorageName :
InReclamation : False
DataStatus : Undefined
PresenceStatus : Present
Size : 1.00 PB
SectorSize : 512 B
Description :
DiskStatus : Online
Virtualized : False
ClientAccessRights : NotDefined
Failure : Undefined
VirtualDiskId :
DiskRole : Unknown
ServerHostId : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3
IsMapped : False
Protected : False
Id : LD:A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3_V.{ea7c7a80-bdf3-11e0-8304-00155d11e921}-00000003
Caption : Storage source from Disk pool 1 on SSV1
ExtendedCaption : Storage source from Disk pool 1 on SSV1
Internal : False
     

-------------- Example 2 Adds logical disk using passthrough disk --------------

Add-DcsLogicalDisk -Server SSV1 -PassThroughDisk "Disk 7"

Creates a logical disk from the pass-through disk named "Disk 7" on the server named "SSV1".

PhysicalDiskId : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3:naa.60030d9056566f6c34345f535356315f
DataStatus : Undefined
PresenceStatus : Present
Size : 50.00 GB
SectorSize : 512 B
Description :
DiskStatus : Online
Virtualized : False
ClientAccessRights : NotDefined
Failure : Undefined
VirtualDiskId :
DiskRole : Unknown
ServerHostId : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3
IsMapped : False
Protected : False
Id : LD:A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3_V.DataCore-naa.60030d9056566f6c34345f535356315f
Caption : Storage source from SSV1
ExtendedCaption : Storage source from SSV1
Internal : False
     

To Table of Contents

NAME

Add-DcsLogMessage

SYNOPSIS

Adds a custom message to the Event Log.

SYNTAX

Add-DcsLogMessage   -Message <String>   [ -Level <String> ]   [ -PostAlert]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Adds a custom message to the Event Log.

PARAMETERS

-Message<String>
Message to add to the Event Log.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Level<String>
The importance of the message. Possible values are "Trace", "Info", "Warning", "Error", and "Diagnostic". If the Level parameter is not included, by default the level will be Info.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PostAlert<SwitchParameter>
Include this parameter to post an alert in addition to the message.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

NOTES

Also see Get-DcsLogMessage, Clear-DcsAlert, Get-DcsAlert, Get-DcsLogMessage

EXAMPLES

-------------- Example 1 Posts a warning message and fires an alert --------------

Add-DcsLogMessage -Message "Power state is LOW BATTERY and write caching will be disabled." -Level Warning -PostAlert

The message "Power state is LOW BATTERY and write caching will be disabled." is output to the Event Log as a Warning message and a warning alert is posted to the Alerts.


To Table of Contents

NAME

Add-DcsPassthroughSnapshot

SYNOPSIS

Creates a full snapshot with a destination that is a pass-through virtual disk.

SYNTAX

Add-DcsPassthroughSnapshot   [ -Server <String> ]   -VirtualDisk <Object>   -Disk <Object>   [ -Name <String> ]   [ -Description <String> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Creates a full snapshot with a destination that is a pass-through virtual disk. The purpose is to allow the migration of virtual disks with pool storage sources to physical disks.

PARAMETERS

-Server<String>
The computer name or ID that identifies the server where the snapshot should be created. The computer name must be unique or the name must be fully qualified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-VirtualDisk<Object>
VirtualDiskData object, name or ID that identifies the virtual disk to use as the source of the snapshot.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Disk<Object>
PhysicalDiskData object, name, or ID that identifies a physical disk to be used as the snapshot destination. The disk should be initialized, but not be partitioned.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Name<String>
Name to assign to the snapshot. If not specified a default name will be assigned. The default name will consist of "[PT}", a space, then the name of the source virtual disk and timestamp of when the snapshot is created. For instance: [PT] <Virtualdiskname><Timestamp>.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Description<String>
Description of the snapshot.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

PhysicalDiskData : Object that identifies the disk.

OUTPUTS

SnapshotData : Object that identifies and describes the snapshot.

NOTES

Also see Get-DcsPhysicalDisk

EXAMPLES

-------------- Example 1 Creates a snapshot that is a passthrough virtual disk. --------------

Add-DcsPassthroughsSnapshot -Server "SSVVM05" -VirtualDisk "Virtual disk 6" -Disk $disk

The cmdlet Get-DcsPhysicalDisk is invoked to get the PhysicalDiskData object for the disk and the object is stored in the variable $disk. The cmdlet Add-DcsPassthroughSnapshot is invoked to create a snapshot on the server named "SSVVM05" using the virtual disk named "Virtual disk 6" as the snapshot source and the passthrough disk identified in the variable $disk. The SnapshotData object is returned.

SourceLogicalDiskId : 9e56ad73-6e66-49d1-93cd-52a07e177c93
DestinationLogicalDiskId : 0bc51a70-7ba0-4f29-83a8-a89dd3342ba1
Type : Full
TimeStamp : 4/20/2016 9:19:05 AM
ActiveOperation : Snap
State : Healthy
Failure : NoFailure
SequenceNumber : 6585
Id : V.{680B0BB6-F2B0-11E5-80E7-00155D138914}-00000007--V
Caption : [PT] Virtual disk 6 @ 4/20/2016 9:19:05 AM
ExtendedCaption : [PT] Virtual disk 6 @ 4/20/2016 9:19:05 AM on
Internal : False
     

To Table of Contents

NAME

Add-DcsPool

SYNOPSIS

Creates a disk pool.

SYNTAX

Add-DcsPool   -Server <String>   -Name <String>   [ -Description <String> ]   [ -StorageAllocationUnitSize <UInt32> ]   [ -SectorSize <UInt32> ]   [ -MaxTierNumber <Int32> ]   [ -TierReservedPct <Int32> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Creates a disk pool. Disks can be added to the pool with Add-DcsPoolMember. Properties can be customized with Set-DcsPoolProperties.

PARAMETERS

-Server<String>
Computer name or ID of the server. The computer name must be unique or the name must be fully qualified.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Name<String>
Name to assign to the disk pool. The disk pool will be created on the specified server.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Description<String>
Description of the disk pool.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-StorageAllocationUnitSize<UInt32>
Number of megabytes to assign as the storage allocation unit (SAU) size of the disk pool. Possible values are "4", "8", "16", "32", "64", "128", "256", "512", or "1024" MB. If the value is not specified, the pool will be created with the default size of 128 MB.

Required: false
Position: named
Default value: 128
Accept pipeline input: false
Accept wildcard characters: false

-SectorSize<UInt32>
Use this parameter to set the sector size for the disk pool. Valid values are "512" and "4096", which represent the number of bytes in the sector. If this parameter is not specified, the default of "512" will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-MaxTierNumber<Int32>
Use this parameter to set a maximum number of tiers for the disk pool. Up to 15 tiers are allowed in a pool. If this parameter is not specified, the default of "3" will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-TierReservedPct<Int32>
Use this parameter to reserve a percentage of space in each pool tier to use for future virtual disk allocations. A valid value is a number between 0 and 20 which refers to the percentage. For example, to reserve 20% space in each tier, enter the value "20". If this parameter is not specified, the default of "0" will be used, which will not reserve any space in the tiers.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

DiskPoolData : Object that identifies and describes the disk pool.

NOTES

Also see Get-DcsPool, Set-DcsPoolProperties.

EXAMPLES

-------------- Example 1 Adds a pool using default selections --------------

Add-DcsPool -Server SSVVM011 -Name "Disk pool 1"

Creates a pool named "Disk pool 1" on the server named "SSVVM01". Since the values are not specified, the pool is created using the default values for SAU (chunksize) size (128 MB), sector size (512 B), and maximum number of tiers (3). The DiskPoolData object is returned.

PoolMode : ReadWrite
ServerId : 9A622809-4DE6-4B9F-9965-EF29852A1D9E
SharedPoolId :
Alias : Disk pool 1
Description :
PresenceStatus : Present
PoolStatus : Running
Type : Dynamic
ChunkSize : 128 MB
SectorSize : 512 B
MaxTierNumber : 3
TierReservedPct : 0
AutoTieringEnabled : True
IsAuthorized : True
InSharedMode : False
SMPAApproved : False
SequenceNumber : 4977
Id : 9A622809-4DE6-4B9F-9965-EF29852A1D9E:{3fddb6db-f226-11e6-80eb-00155d138904}
Caption : Disk pool 1
ExtendedCaption : Disk pool 1 on SSVVM01
Internal : False
     

-------------- Example 2 Adds a pool using nondefault parameter values. --------------

Add-DcsPool -Server "SSVVM04" -Name "VM04Pool1" -StorageAllocationUnitSize 1024 -SectorSize 4096 -MaxTierNumber 5 -TierReservedPct 20

A disk pool named "VM04Pool1" is created on the server named "SSVVM04". The storage allocation unit size is 1024 MB (1 GB) and the sector size is 4096 bytes (4 KB). The pool will have 5 tiers and each tier will have 20% reserved space. The DiskPoolData object is returned.

PoolMode : ReadWrite
ServerId : FF140341-D7FC-4DF7-95B3-AE551F099F00
SharedPoolId :
Alias : VM04Pool1
Description :
PresenceStatus : Present
PoolStatus : Running
Type : Dynamic
ChunkSize : 1 GB
SectorSize : 4 KB
MaxTierNumber : 5
TierReservedPct : 20
AutoTieringEnabled : True
IsAuthorized : True
InSharedMode : False
SMPAApproved : False
SequenceNumber : 7126
Id : FF140341-D7FC-4DF7-95B3-AE551F099F00:{911d1f40-8d55-11e5-80ee-00155d138910}
Caption : VM04Pool1
ExtendedCaption : VM04Pool1 on SSVVM04
Internal : False
     

To Table of Contents

NAME

Add-DcsPoolMember

SYNOPSIS

Adds a physical disk or mirror to an existing pool.

SYNTAX

Add-DcsPoolMember   [ -Server <String> ]   -Pool <String>   -Disk <Object>   [ -Count <Int32> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsPoolMember   [ -Server <String> ]   -Pool <String>   -Disk <Object>   [ -MirrorDisk <String> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsPoolMember   [ -Server <String> ]   -Pool <String>   -PoolMember <String>   [ -MirrorDisk <String> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Adds a physical disk or mirror to an existing pool.

PARAMETERS

-Server<String>
Computer name or ID of the server. The computer name must be unique or the name must be fully qualified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Pool<String>
Name or ID of the pool to which the disks should be added. To resolve by name, the name must be unique to the server group or the server must be specified.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Disk<Object>
PhysicalDiskData object, name, or ID that identifies a physical disk to add to the pool. The name must be unique to the server group or the server must be specified.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Count<Int32>
The Count parameter can limit the number of disks added to the pool using the Disk parameter when the Disks parameter is obtained from the pipeline and includes multiple objects. If not specified, all disks will be added to the pool.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-MirrorDisk<String>
Name or ID that identifies a physical disk to be added to the pool as a mirror. To resolve by name, the name must be unique to the server group or the server must be specified. The MirrorDisk parameter can be used with the Disk parameter or PoolMember parameter.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PoolMember<String>
PoolMember ID or caption that identifies the physical disk that is a member of a disk pool. Use this parameter when adding a mirror to an existing disk in a pool.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

PhysicalDiskData : Object the identifies the disk.

OUTPUTS

PoolMemberData : Object the identifies and describes the pool member.

NOTES

Also see Set-DcsPoolProperties, Get-DcsPhysicalDisk, Unlock-DcsPhysicalDisk, Set-DcsPhysicalDiskProperties.

EXAMPLES

-------------- Example 1 Adds one physical disk to a pool --------------

Add-DcsPoolMember -Pool "Disk pool 1" -Disk "WDC WD800AAJS-N8TDA03"

Adds a physical disk named "WDC WD800AAJS-N8TDA03" to the pool named "Disk pool 1". In this case, the physical disk name must be unique in the server group.

DiskPoolId : 101796F5-90A6-4929-B28D-98D195834677:{2186893e-985e-11e5-80e7-00155d138910}
DiskInRecoveryId :
DiskTier : 2
MemberState : Healthy
Size : 200.00 GB
SectorSize : 512 B
IsMirrored : False
SequenceNumber : 8684
Id : f155ff13-5cf2-4289-9eba-4252518d6f23
Caption : WDC WD800AAJS-N8TDA03
ExtendedCaption : Pool disk WDC WD800AAJS-N8TDA03 on SSVVM04
Internal : False
     

-------------- Example 2 Adds physical disks by piping objects --------------

Get-DcsPhysicalDisk -Server SSV1 -Type Uninitialized | Add-DcsPoolMember -Pool  "Disk pool 1" -Count 2

The cmdlet Get-DcsPhysicalDisk is invoked to get PhysicalDiskData objects for all the disks of type "uninitialized" on the server "SSV1". Those objects are piped to the cmdlet Add-DcsPoolMember to add two physical disks to the pool "Disk pool 1".

DiskPoolId : 8BD7BD0F-F5F9-40DB-B8B0-6ABB74D43F81:{2b28c5b6-a04d-11e1-96c0-00155d11e929}
DiskInRecoveryId :
DiskTier : 2
MemberState : Healthy
Size : 500.00 GB
SectorSize : 512 B
IsMirrored : False
SequenceNumber : 6738
Id : dfc54ce8-314d-4b36-a09d-a40c958f6975
Caption : WDC WD800AAJS-N8TDA02
ExtendedCaption : Pool disk WDC WD800AAJS-N8TDA02 on SSV1
Internal : False
     
DiskPoolId : 8BD7BD0F-F5F9-40DB-B8B0-6ABB74D43F81:{2b28c5b6-a04d-11e1-96c0-00155d11e929}
DiskInRecoveryId :
DiskTier : 2
MemberState : Healthy
Size : 100.00 GB
SectorSize : 512 B
IsMirrored : False
SequenceNumber : 6746
Id : d6ca93da-9086-49f7-a80b-00630dcecb66
Caption : WDC WD800AAJS-N8TDA010
ExtendedCaption : Pool disk WDC WD800AAJS-N8TDA010 on SSV1
Internal : False
     

-------------- Example 3 Adds a mirror disk to a pool. --------------

$PM = Get-DcsPoolMember -Pool "Disk pool 1" -Disk "SSV1-WDC100-D1"

Add-DcsPoolMember -Pool $PM.DiskPoolId -PoolMember $PM -MirrorDisk "SSV1-WDC100-D2"

The cmdlet Get-DcsPoolMember is invoked to get the PoolMemberData object for the physical disk named "SSV1-WDC100-D1" in the pool named "Disk pool 1". The object is stored in the variable $PM.
The cmdlet Add-DcsPoolMember is invoked using the object in the variable to get the Disk pool ID for the Pool parameter and the PoolMemberData object for the PoolMember parameter. The MirrorDisk parameter is the physical disk named "SSV1-WDC100-D2". The updated PoolMemberData object is returned.
DiskPoolId : 8BD7BD0F-F5F9-40DB-B8B0-6ABB74D43F81:{2b28c5b6-a04d-11e1-96c0-00155d11e929}
DiskInRecoveryId : {0b89a4a7-242e-4f8b-926f-ecc9397d5cdf}
DiskTier : 2
MemberState : OutOfSync
Size : 100.00 GB
SectorSize : 512 B
IsMirrored : True
SequenceNumber : 7335
Id : ed78b36a-613a-4c28-b4d8-f00d0fc5fbec
Caption : SSV1-WDC100-D1|SSV1-WDC100-D2
ExtendedCaption : Pool mirror SSV1-WDC100-D1|SSV1-WDC100-D2 on SSV1
Internal : False
     

To Table of Contents

NAME

Add-DcsRecordingPoint

SYNOPSIS

Adds counters to the specified recording session.

SYNTAX

Add-DcsRecordingPoint   [ -Session <Object> ]   [ -Connection <String> ]   -Instance <Object>   [ -Counter <String[]> ]   [ -PipelineVariable <String> ]

Add-DcsRecordingPoint   [ -Session <Object> ]   [ -Connection <String> ]   -Category <String>   [ -Counter <String[]> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Adds counters to the specified recording session. A specific counter can be added or all counters in a category can be added. Counters can be added for all instances or specific instances.

PARAMETERS

-Session<Object>
The PerformanceRecordingSessionData object, Id, or Caption that identifies the recording session. If the session is not specified, the "!UserRecordingSession" will used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Instance<Object>
Use this parameter to add an instance to the recording session. The value is the InstanceRecordingPointData object or any object which identifies the instance.

Required: true
Position: 1
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Counter<String[]>
One or more specific counters to add to the recording session. A valid value is the name of the counter or a comma separated list of counters. To get counter names, use the cmdlet Get-DcsPerformanceCounter and pass the specific object; a list of counter names will be returned for the object.

Required: false
Position: 2
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Category<String>
Use this parameter to add a category to the recording session. Valid values for category names include: "DiskPool", "LogicalDisk", "Machine", "HostGroup", "PhysicalDisk", "PoolMember", "Replication", "RollbackGroup", "ScsiPort", "ServerGroup", "ServerMachine", "ServerScsiPort", "SharedDiskPool", "SharedPhysicalDisk", "SnapshotGroup", "SnapshotRelation", "StreamLogicalDisk", "VirtualDiskGroup", "VirtualDisk", "VirtualLogicalUnit", "VirtualTargetDevice", and "VirtualTargetDomain". Note: "Machine" refers to client host category and "ServerMachine" refers to server category. "ScsiPort" refers to client host SCSI ports category and "ServerScsiPort" refers to server SCSI ports category. "PoolMember" refers to physical disks in pools and "PhysicalDisk" refers to physical disks not in pools.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

InstanceRecordingPointData, CategoryRecordingPointData, or any object type that identifies an instance.

OUTPUTS

InstanceRecordingPointData or CategoryRecordingPointData : Object that identifies and describes either a category or instance of a counter.

NOTES

Also see Get-DcsPerformanceCounter, Remove-DcsRecordingPoint, Get-DcsRecordingPoint.

EXAMPLES

-------------- Example 1 Adds all counters in a specific category for all instances for a specific session. --------------

Add-DcsRecordingPoint -Session "User recording session" -Category PhysicalDisk

The cmdlet Add-DcsRecordingPoint is invoked with the single parameter Category and the value "PhysicalDisk". This results in all physical disk counters being added for all physical disk instances to the "User recording session". The object CategoryRecordingPointData is returned. Note: If the last counter is removed from the recording point Instance or Category, the entire point will be removed from the list.

Category                   Counters
--------                   --------
PhysicalDiskPerformance
                                

-------------- Example 2 Adds all counters for a specific instance --------------

Get-DcsClient -Client "HostVM1" | Add-DcsRecordingPoint -Session "User recording session"

The cmdlet Get-DcsClient is invoked with the parameter Client specified as "HostVM1". The results are piped to the cmdlet Add-DcsRecordingPoint to identify the instance. This results in all counters for the instance "HostVM1" being added to the "User recording session" as defined in the PerformanceRecordingSessionData object. The object InstanceRecordingPointData is returned.

InstanceId                                                  Counters
----------                                                  --------
c14ee231f735470195253a98961d5674
                                

-------------- Example 3 Adds a specific counter for all instances --------------

Add-DcsRecordingPoint -Category PhysicalDisk -Counter TotalOperations

The cmdlet Add-DcsRecordingPoint is invoked with the parameter Category having a value of "PhysicalDisk" and the parameter Counter having a value of "TotalOperations". This results in the counter "TotalOperations" being added for all physical disk instances in the server group for the default connection. The object CategoryRecordingPointData is returned.


-------------- Example 4 Adds specific counters for a specific instance --------------

Get-DcsClient -Client HostVM1 | Get-DcsPerformanceCounter

TotalBytesTransferred : 0
TotalBytesRead        : 0
TotalBytesWritten     : 0
TotalOperations       : 0
TotalReads            : 0
TotalWrites           : 0
CollectionTime        : 4/10/2013 7:58:28 PM
NullCounterMap        : 0

Get-DcsClient -Client HostVM1 | Add-DcsRecordingPoint -Counter "TotalOperations", "TotalReads", "TotalWrites"

To obtain a list of counters for the specific client named "HostVM1", the cmdlet Get-DcsClient is invoked and the results are piped to the cmdlet Get-DcsPerformanceCounter.


To Table of Contents

NAME

Add-DcsReplication

SYNOPSIS

Creates a replication relationship between a source and a destination virtual disk in order to asynchronously mirror data.

SYNTAX

Add-DcsReplication   -SourceServer <String>   -DestinationServer <String>   -SourceDisk <String>   -DestinationDisk <String>   [ -DuplicateDiskId]   [ -OfflineInitialization]   [ -Yes]   [ -Connection <String> ]   [ -PipelineVariable <String> ]   [ -WhatIf]   [ -Confirm]

DESCRIPTION

Creates a replication relationship between a source and a destination virtual disk in order to asynchronously mirror data. After the replication is created, checkpoint markers can be created and used to update snapshots on the destination server, see Set-ReplicationSnapshot and Set-ReplicationCheckPoint.

PARAMETERS

-SourceServer<String>
Computer name or ID of the local source server. The computer name must be unique or the name must be fully qualified.

Required: true
Position: 1
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-DestinationServer<String>
Computer name or ID of the remote destination server. The computer name must be unique or the name must be fully qualified.

Required: true
Position: 2
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-SourceDisk<String>
The name or ID that identifies the virtual disk to be used as the source of the replication. The source disk must exist on the source server.

Required: true
Position: 3
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-DestinationDisk<String>
The name or ID that identifies the virtual disk to be used as the destination of the replication. The destination virtual disk must exist on the destination server.

Required: true
Position: 4
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-DuplicateDiskId<SwitchParameter>
Specify this parameter only if both the source and the destination virtual disks will be served to client hosts that require the same SCSI inquiry ID (virtual product information).

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-OfflineInitialization<SwitchParameter>
Use this parameter to specify offline initialization for this replication. (See Start-DcsReplicationOfflineInitialization to start the initialization.) If not specified, an automatic online initialization will occur.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Yes<SwitchParameter>
Creating a replication is an operation that requires confirmation because the contents of the destination virtual disk will be overwritten. Specify this parameter to confirm your intention to create the replication and prevent user interaction during scripted scenarios.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-WhatIf<SwitchParameter>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Confirm<SwitchParameter>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

AsyncReplicationData : Object that identifies and describes the relationship between the source and destination virtual disks in the replication.

NOTES

Also see Add-DcsPartnerGroup, Set-DcsReplicationBufferFolder, Set-DcsReplicationCheckPoint, Set-DcsReplicationSnapshot, Reverse-DcsReplication, Start-DcsReplicationOfflineInitialization, Stop-DcsReplicationOfflineInitialization, Set-DcsReplicationInitializationType, Enable-DcsReplicationTestMode.

EXAMPLES

-------------- Example 1 Creates a replication using offline initialization --------------

Add-DcsReplication -SourceServer SSV1 -DestinationServer SSV3 -SourceDisk "Virtual Disk 5" -DestinationDisk "Virtual Disk 6" -OfflineInitialization -Yes

Creates a replication relationship between a virtual disk named "Virtual Disk 5" on the Source Server named "SSV1" and the virtual disk named "Virtual Disk 6" on the Destination Server named "SSV3". Offline initialization is specified (see Start-DcsReplicationOfflineInitialization). The parameter Yes is specified to prevent user interaction.

FirstServerId : 74EDD1B3-6682-46A7-943C-2F0168CEC699
FirstVirtualDiskId : 01cf04e35b5a4f23913c329deb0cc3da
SecondServerId : 4d188191-a5b7-4bc1-9ff0-07fa3cddc2a7:863F19DC-41D6-4D46-92A6-30686E3A24AC
SecondVirtualDiskId : a19d230f8c29423f9e23c14d059916c1
IsActiveSide : True
ReplicationState : Initializing
FailureStatus : NoReplicationDefinedForPartner
TransferStatus : Disabled
Paused : False
CheckpointSnapshotId :
AutoAsyncReplicationLicense : Enabled
OfflineInitializationSupported : False
InitializationType : Offline
OfflineInitializationBuffer :
OfflineInitStatus : WaitToStartOfflineInit
InitializationFailureStatus : NoFailure
Id : 74c9e07c-e419-48a3-8215-097c89d8bcd0
Caption : Virtual disk 5
ExtendedCaption : Virtual disk 5 on SSV3
Internal : False
     

To Table of Contents

NAME

Add-DcsReplicationConsistencyRollback

SYNOPSIS

Creates a rollback group of expiring rollbacks for the specified virtual disk group using a Consistency Point marker stored on the replication destination.

SYNTAX

Add-DcsReplicationConsistencyRollback   -VirtualDiskGroup <Object>   [ -TimeStamp <Object> ]   [ -DuplicateDiskId]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsReplicationConsistencyRollback   -VirtualDiskGroup <Object>   [ -UserDefinedCode <Byte> ]   [ -DuplicateDiskId]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Creates a rollback group of expiring rollbacks for the specified virtual disk group using a Consistency Point marker stored on the replication destination. The marker to use as a restore point can be specified. If optional parameters are not specified, the latest common consistency point marker for the specified virtual disk group will be used as the restore point. This cmdlet requires Continuous Data Protection (CDP) to be enabled on all virtual disks in the virtual disk group on the replication destination.

PARAMETERS

-VirtualDiskGroup<Object>
VirtualDiskGroupData object, name or ID that identifies a virtual disk group on the replication destination that has received replication consistency markers. The VirtualDiskGroupData object can be obtained with Get-DcsVirtualDiskGroup.

Required: true
Position: 1
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-TimeStamp<Object>
Use this parameter to create a rollback group using the specified date and time as a restore point. The date and time must correspond to a Replication Consistency Point marker stored on the replication destination server. If this parameter is not specified, then the latest common marker stored for the virtual disk group will be used to create the rollback group. (see Example 1) Time should be reflected in UTC. The value can be supplied from the GroupConsistencyPointData object which is returned from the cmdlet Get-DcssReplicationConsistencyPoint. The value can also be supplied as a DateTime object. One way to create a DateTime object is using the PowerShell cmdlet Get-Date. The value can also be provided in a string with the date and exact time which includes milliseconds in this format "yyyy-MM-dd HH:mm:ss.fffffff", for example "2015-06-24 19:56:45.2958955". (See example 4)

Required: false
Position: 2
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-DuplicateDiskId<SwitchParameter>
Specify this parameter only if both the source and the destination virtual disks will be served to clients (hosts) that require the same SCSI inquiry ID (virtual product information).

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-UserDefinedCode<Byte>
Use the parameter to create the latest rollback group based on the specified marker. A marker with the specified code must exist. Valid values for the code are from 0 - 255.

Required: false
Position: 2
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

VirtualDiskGroupData : Object that identifies and describes the virtual disk group.

OUTPUTS

RollbackGroupData : Object that identifies and describes the rollback group that was created.

NOTES

Also see Set-DcsReplicationConsistencyPoint, Get-DcsReplicationConsistencyPoint

EXAMPLES

-------------- Example 1 Creates a rollback group for the specified virtual disk group and timestamp. --------------

$point = Get-DcsReplicationConsistencyPoint -VirtualDiskGroup "VD Group 1 Remote" -UserDefinedCode 10
$point

TimeStamp                                                                                               UserDefinedCode
---------                                                                                               ---------------
6/24/2015 9:41:03 PM                                                                                                 10
6/24/2015 7:56:45 PM                                                                                                 10
6/24/2015 7:41:51 PM                                                                                                 10


Add-DcsReplicationConsistencyRollback -VirtualDiskGroup "VD Group 1 Remote" -TimeStamp $point[1].TimeStamp

The cmdlet Get-DcsReplicationConsistencyPoint is invoked to get the marker data for the virtual disk group named "VD Group 1 Remote" with a user-defined code of "10". The data is stored in the variable $point, where the data can be viewed. The cmdlet Add-DcsReplicationConsistencyRollback is invoked to create a rollback group for the virtual disk group named "VD Group 1 Remote". The restore point of the rollbacks will be the timestamp of the second indexed entry [1] in the object. (Indexes in the object begin with [0].) In this manner rollback groups can be created for timestamps other than the latest common marker.

TotalCapacity : 21 GB
ParentGroupId : {be8b88ea-daca-424e-af18-282835a27f26}
Alias : VD Group 1 Remote @ 6/24/2015 7:56:45 PM UTC
Description :
SequenceNumber : 3369
Id : {c71334b5-e3b9-4892-91f7-d194253d2d71}
Caption : VD Group 1 Remote @ 6/24/2015 7:56:45 PM UTC
ExtendedCaption : VD Group 1 Remote @ 6/24/2015 7:56:45 PM UTC
Internal : False
     

-------------- Example 2 Creates rollback groups for virtual disks in multiple virtual disk groups using the default latest common marker --------------

$RepConsistencyPtGroups = Get-DcsVirtualDiskGroup | where {$_.Description -like "*consistency point*"}

$RepConsistencyPtGroups | ForEach {Add-DcsReplicationConsistencyRollback -VirtualDiskGroup $_}

The cmdlet Get-DcsVirtualDiskGroup is used to get all the objects for virtual disk groups that contain the words "consistency point" in the description. (This requires the user to provide a description.) The returned RollbackGroupData objects are saved to the variable "$RepConsistencyPtGroups. Then the cmdlet Add-DcsReplicationConsistencyRollback is invoked for each VirtualDiskGroupData object saved in the variable. A rollback group is created for each virtual disk group. In this case, there were two groups. The restore point of the rollbacks will be the latest common marker stored on the replication destination.

TotalCapacity : 21 GB
ParentGroupId : {be8b88ea-daca-424e-af18-282835a27f26}
Alias : VD Group 1 Remote 5 @ 6/24/2015 9:41:03 PM UTC
Description :
SequenceNumber : 6200
Id : {346b6b9e-1bf6-41e5-9fbc-3eecb40f2378}
Caption : VD Group 1 Remote 5 @ 6/24/2015 9:41:03 PM UTC
ExtendedCaption : VD Group 1 Remote 5 @ 6/24/2015 9:41:03 PM UTC
Internal : False
     
TotalCapacity : 30 GB
ParentGroupId : {0e3a9ae5-bb8e-43d8-a95d-7d82ae3c312b}
Alias : VD Group 2 Remote @ 7/9/2015 2:19:34 PM UTC
Description :
SequenceNumber : 6334
Id : {9f8f93d4-e2f5-40a0-84c9-51054149ceac}
Caption : VD Group 2 Remote @ 7/9/2015 2:19:34 PM UTC
ExtendedCaption : VD Group 2 Remote @ 7/9/2015 2:19:34 PM UTC
Internal : False
     

-------------- Example 3 Creates a rollback group using the GroupConsistencyPointData object as a timestamp. --------------

$point = Get-DcsReplicationConsistencyPoint -VirtualDiskGroup "VD Group 1 Remote" -UserDefinedCode 10
$point

TimeStamp                                                                                               UserDefinedCode
---------                                                                                               ---------------
6/24/2015 9:41:03 PM                                                                                                 10
6/24/2015 7:56:45 PM                                                                                                 10
6/24/2015 7:41:51 PM                                                                                                 10


Add-DcsReplicationConsistencyRollback -VirtualDiskGroup "VD Group 1 Remote" -TimeStamp $point[1]

The cmdlet Get-DcsReplicationConsistencyPoint is invoked to get the marker data for the virtual disk group named "VD Group 1 Remote" with a user-defined code of "10". The data is stored in the variable $point, where the data can be viewed. The cmdlet Add-DcsReplicationConsistencyRollback is invoked to create a rollback group for the virtual disk group named "VD Group 1 Remote". The restore point of the rollbacks will be the timestamp of the second indexed entry [1] in the object. (Indexes in the object begin with [0].) In this manner rollback groups can be created for timestamps other than the latest common marker.

TotalCapacity : 21 GB
ParentGroupId : {be8b88ea-daca-424e-af18-282835a27f26}
Alias : VD Group 1 Remote @ 6/24/2015 7:56:45 PM UTC
Description :
SequenceNumber : 3369
Id : {c71334b5-e3b9-4892-91f7-d194253d2d71}
Caption : VD Group 1 Remote @ 6/24/2015 7:56:45 PM UTC
ExtendedCaption : VD Group 1 Remote @ 6/24/2015 7:56:45 PM UTC
Internal : False
     

-------------- Example 4 Creates a rollback group using a string as the timestamp. --------------

$Point = Get-DcsReplicationConsistencyPoint -VirtualDiskGroup "VD Group 1 Remote" -UserDefinedCode 10

$Point

TimeStamp                                                                                               UserDefinedCode
---------                                                                                               ---------------
6/24/2015 9:41:03 PM                                                                                                 10
6/16/2015 7:56:45 PM                                                                                                 10
6/16/2015 7:41:51 PM                                                                                                 10


$time = $point.TimeStamp[1].ToString("O")
$time
2015-06-16T19:56:45.2958955Z

Add-DcsReplicationConsistencyRollback -VirtualDiskGroup "VD Group 1 Remote" -TimeStamp $time

The cmdlet Get-DcsReplicationConsistencyPoint is invoked to get the marker data for the virtual disk group named "VD Group 1 Remote" with a user-defined code of "10". The data is stored in the variable $Point, where the data can be viewed. 
The restore point of the rollbacks will be the timestamp of the second indexed entry [1] in the object, which is stored in the variable $time using the PowerShell function ToString("O"). (Indexes in the object begin with [0].)

To Table of Contents

NAME

Add-DcsReplicationPartnerGroup

SYNOPSIS

Partners one server group to another server group for the purpose of performing replications.

SYNTAX

Add-DcsReplicationPartnerGroup   -Server <String>   -LocalUserName <String>   -LocalPassword <String>   -RemoteUserName <String>   -RemotePassword <String>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsReplicationPartnerGroup   -Server <String>   -LocalCredential <PSCredential>   -RemoteCredential <PSCredential>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Partners one server group to another server group in order to perform replications, see Add-DcsReplication. A replication buffer must be created, see Set-DcsReplicationBufferFolder.

PARAMETERS

-Server<String>
Computer name or ID of one of the servers in the remote destination group. The computer name must be unique or the name must be fully qualified. The specified server will be used for communications between local (source) and remote (destination) server groups.

Required: true
Position: 1
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-LocalUserName<String>
User name of the account used to connect to the local (source) server group. User names must match Windows user accounts and must reside on all servers in the local server group. Credentials can be domain-wide or local (workgroup). If credentials are domain-wide, include the domain with the name for example: DOMAIN\user name.) Name resolution is required between local and remote groups.

Required: true
Position: 2
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-LocalPassword<String>
Login password that corresponds to the local user name.

Required: true
Position: 3
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-RemoteUserName<String>
User name of the account used to connect to the remote (destination) server group. User names must match Windows user accounts and must reside on all servers in the remote server group. Credentials can be domain-wide or local (workgroup). If credentials are domain-wide, include the domain with the name for example: DOMAIN\user name.) Name resolution is required between local and remote groups.

Required: true
Position: 4
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-RemotePassword<String>
Login password that corresponds to the remote user name.

Required: true
Position: 5
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-LocalCredential<PSCredential>
The PSCredential object containing user name and password for the local server group. This object can be obtained by invoking the Windows PowerShell cmdlet Get-Credential, see Example 2. In this manner, credentials can be passed through the object instead of typing the credentials.

Required: true
Position: 2
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-RemoteCredential<PSCredential>
The PSCredential object containing user name and password for the remote server group. This object can be obtained by invoking the Windows PowerShell cmdlet Get-Credential, see Example 2. In this manner, credentials can be passed through the object instead of typing the credentials.

Required: true
Position: 3
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

PartnershipData : Object that identifies and describes the replication partner group.

NOTES

Also see Add-DcsReplication, Set-DcsReplicationBufferFolder, Remove-DcsReplicationPartnerGroup, Get-DcsReplicationPartnerGroup.

EXAMPLES

-------------- Example 1 Adds a replication partner group for replication --------------

Add-DcsReplicationPartnerGroup -Server SSV3 -LocalUserName administrator -LocalPassword Adminpw! -RemoteUserName administrator -RemotePassword Adminpw!

Adds a replication partner group to the current server group for replication purposes. In this example, the partner group contains a server named "SSV3". The User Names and Passwords are "administrator" and "Adminpw!" on both local and remote servers.

GroupId : 091705db-3bfd-4c3a-9d58-8455fe6628ef
HostAddresses : {SSV3.datacoresoftware.com}
IncomingCredentials : DataCore.Executive.ConnectionCredentials
OutgoingCredentials : DataCore.Executive.ConnectionCredentials
Connected : True
EnableCompression : True
Id : 285ea682-2b07-4020-8f52-b87441579783
Caption : ControllerProxy
ExtendedCaption : ControllerProxy
     

-------------- Example 2 Adds a replication partner group by passing the PSCredential objects --------------

$localCred = Get-Credential

$remoteCred = Get-Credential

Add-DcsReplicationPartnerGroup -Server SSV3.datacoresoftware.com -LocalCredential $localCred -RemoteCredential $remoteCred

The Windows PowerShell cmdlet Get-Credential is invoked to collect the credentials for the local and remote server groups. When Get-Credential is invoked a dialog box opens and the user name and password can be entered in a secure manner. The local credentials are saved to the variable $localCred and the remote credentials are saved to the variable $remoteCred. 
The cmdlet Add-DcsReplicationPartnerGroup is invoked to create a replication partnership between the local and remote server groups. The remote server is named "SSV3.datacoresoftware.com" and is identified by the parameter Server. Local credentials are passed using $localCred as the value for the parameter LocalCredential. Remote credentials are passed using $remoteCred as the value for the parameter RemoteCredential.
$remoteCred = Get-Credential
                                

To Table of Contents

NAME

Add-DcsRole

SYNOPSIS

Creates a custom user role and assigns privileges to the role.

SYNTAX

Add-DcsRole   -Name <String>   [ -Description <String> ]   [ -General <GeneralPrivileges> ]   [ -Ports <PortPrivileges> ]   [ -ClientMachines <ClientMachinePrivileges> ]   [ -HostGroups <HostGroupPrivileges> ]   [ -ServerMachines <ServerMachinePrivileges> ]   [ -ServerMachineGroups <ServerMachineGroupPrivileges> ]   [ -VirtualDisks <VirtualDiskPrivileges> ]   [ -Snapshots <SnapshotPrivileges> ]   [ -Rollbacks <RollbackPrivileges> ]   [ -Replications <ReplicationPrivileges> ]   [ -PhysicalDisks <PhysicalDiskPrivileges> ]   [ -DiskPools <DiskPoolPrivileges> ]   [ -Controller <ExecutivePrivileges> ]   [ -PartnerController <PartnerControllerPrivileges> ]   [ -Users <UserPrivileges> ]   [ -Roles <RolePrivileges> ]   [ -StorageProfiles <StorageProfilePrivileges> ]   [ -Tasks <TaskPrivileges> ]   [ -Monitors <MonitorPrivileges> ]   [ -Logs <LogPrivileges> ]   [ -VirtualDiskGroups <VirtualDiskGroupPrivileges> ]   [ -License <LicensePrivileges> ]   [ -PerformanceRecording <PerformanceRecordingPriviledges> ]   [ -VirtualDiskTemplate <VirtualDiskTemplatePrivileges> ]   [ -Witness <WitnessPrivileges> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Creates a custom user role and assigns privileges to the role. The ability to view information in the software, which is one of the General privileges, is automatically added to each role.

PARAMETERS

-Name<String>
Name of the user role.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Description<String>
Description of the user role.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-General<GeneralPrivileges>
General privilege set grants privileges to users to perform general actions, such as viewing information in the software. Valid values include "All" to add the privilege set or "None" to remove the privilege set. The ability to view information in the software is automatically added to each role without this privilege being specified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Ports<PortPrivileges>
Ports privilege set grants privileges to users to perform actions on Fibre Channel and iSCSI ports. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-ClientMachines<ClientMachinePrivileges>
ClientMachines privilege set grants privileges to users to perform actions on hosts. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-HostGroups<HostGroupPrivileges>
HostGroups privilege set grants privileges to users to perform actions on host groups. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-ServerMachines<ServerMachinePrivileges>
ServerMachines privilege set grants privileges to users to perform actions on DataCore Servers. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-ServerMachineGroups<ServerMachineGroupPrivileges>
ServerMachineGroups privilege set grants privileges to users to perform actions on server groups. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-VirtualDisks<VirtualDiskPrivileges>
VirtualDisks privilege set grants privileges to users to perform actions on virtual disks. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Snapshots<SnapshotPrivileges>
Snaphots privilege set grants privileges to users to perform actions on snapshots. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Rollbacks<RollbackPrivileges>
Rollbacks privilege set grants privileges to users to perform actions on rollbacks. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Replications<ReplicationPrivileges>
Replications privilege set grants privileges to users to perform actions on replications. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PhysicalDisks<PhysicalDiskPrivileges>
PhysicalDisks privilege set grants privileges to users to perform actions on physical disks. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-DiskPools<DiskPoolPrivileges>
DiskPools privilege set grants privileges to users to perform actions on disk pools. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Controller<ExecutivePrivileges>
Controller privilege set grants privileges to users to perform actions on service level operations. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PartnerController<PartnerControllerPrivileges>
PartnerController privilege set grants privileges to users to perform actions on Replication Partner. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Users<UserPrivileges>
Users privilege set grants privileges to users to perform actions on user accounts. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Roles<RolePrivileges>
Roles privilege set grants privileges to users to perform actions on user roles. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-StorageProfiles<StorageProfilePrivileges>
StorageProfiles privilege set grants privileges to users to perform actions on storage profiles. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Tasks<TaskPrivileges>
Tasks privilege set grants privileges to users to perform actions on tasks. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Monitors<MonitorPrivileges>
Monitors privilege set grants privileges to users to perform actions on system health monitors. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Logs<LogPrivileges>
Logs privilege set grants privileges to users to perform actions on event logs. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-VirtualDiskGroups<VirtualDiskGroupPrivileges>
VirtualDiskGroups privilege set grants privileges to users to perform actions on virtual disk groups. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-License<LicensePrivileges>
License privilege set grants privileges to users to perform actions on software licenses. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PerformanceRecording<PerformanceRecordingPriviledges>
PerformanceRecording privilege set grants privileges to users to perform actions on performance recording sessions. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-VirtualDiskTemplate<VirtualDiskTemplatePrivileges>
VirtualDiskTemplate privilege set grants privileges to users to perform actions on virtual disk templates. Valid values include "All" to add the privilege set or "None" to remove the privilege set.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Witness<WitnessPrivileges>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

RoleData : Object that identifies and describes the role.

NOTES

Also see Get-DcsRole, Remove-DcsRole.

EXAMPLES

-------------- Example 1 Adds a custom role. --------------

Add-DcsRole -Name "Networking" -Description "Role for Network Administrators" -General ALL -Ports ALL -ClientMachines ALL -HostGroups ALL -ServerMachines ALL -ServerMachineGroups ALL -VirtualDisks ALL -Snapshots ALL -Rollbacks ALL -Replications ALL -PhysicalDisks ALL -DiskPools ALL -PartnerController ALL -Controller ALL -Tasks ALL -Monitors ALL -Logs ALL -VirtualDiskGroups ALL -PerformanceRecording ALL

Creates a role named "Networking" which is a role reserved for Network Administrators. All privileges in the following privilege sets are assigned to the role: General, Ports, ClientMachines, HostGroups, ServerMachines, ServerMachineGroups, VirtualDisks, Snapshots, Rollbacks, Replications, PhysicalDisk, DiskPools, PartnerController, Controller, Tasks, Monitors, Logs, VirtualDiskGroups, and PerformanceRecording. The RoleData object is returned.

Alias : Networking
Description : Role for Network Administrators
Privileges : General privileges: All
Port privileges : All
Host privileges : All
Host group privileges : All
DataCore Server privileges : All
DataCore Server group privileges : All
Virtual disk privileges : All
Snapshot privileges : All
Rollback privileges : All
Replication privileges : All
Physical disk privileges : All
Disk pool privileges : All
Service level privileges : All
Replication partner privileges : All
Task privileges : All
System health monitor privileges : All
Log privileges : All
Virtual disk group privileges : All
Performance recording privileges : All
     
IsPredefined : False
SequenceNumber : 3146
Id : 5a418634-6ca6-410b-a25e-2ab33bb7b417
Caption : Networking
ExtendedCaption : Networking
Internal : False
     

To Table of Contents

NAME

Add-DcsRollback

SYNOPSIS

Creates a rollback from a virtual disk with Continuous Data Protection (CDP). This operation can also be performed on a virtual disk group and creates a rollback group.

SYNTAX

Add-DcsRollback   [ -Server <String> ]   -VirtualDisk <Object>   [ -Name <String> ]   [ -Description <String> ]   -Pool <String>   [ -AutoExpire]   [ -DuplicateDiskId]   -TimeStamp <DateTime>   [ -AssignToCurrentUser]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsRollback   [ -Server <String> ]   -VirtualDisk <Object>   [ -Name <String> ]   [ -Description <String> ]   -Pool <String>   [ -AutoExpire]   [ -DuplicateDiskId]   -TimeSpan <TimeSpan>   [ -AssignToCurrentUser]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsRollback   [ -Server <String> ]   -VirtualDiskGroup <Object>   [ -Name <String> ]   [ -Description <String> ]   -Pool <String>   [ -AutoExpire]   [ -DuplicateDiskId]   -TimeStamp <DateTime>   [ -AssignToCurrentUser]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsRollback   [ -Server <String> ]   -VirtualDiskGroup <Object>   [ -Name <String> ]   [ -Description <String> ]   -Pool <String>   [ -AutoExpire]   [ -DuplicateDiskId]   -TimeSpan <TimeSpan>   [ -AssignToCurrentUser]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Creates a rollback from virtual disk with Continuous Data Protection (CDP). This operation can also be performed on a virtual disk group and creates a rollback group. The rollback can be created to expire automatically or stay persistent (see AutoExpire). A special rollback marker can also be created that flushes the cache before creating the rollback, see the description for the TimeSpan parameter. CDP must be enabled for a virtual disk before a rollback can be created, see Enable-DcsDataProtection.

PARAMETERS

-Server<String>
Computer name or ID of the server. The computer name must be unique or the name must be fully qualified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-VirtualDisk<Object>
VirtualDiskData object, name, or ID that identifies the CDP-enabled virtual disk, which is the source of the rollback.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Name<String>
Name to assign to the rollback. If not specified, a default name will be assigned consisting of the name of the CDP-enabled virtual disk and the timestamp.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Description<String>
Description of the rollback.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Pool<String>
Name or ID of the pool where the rollback should be created. To resolve by name, the name must be unique to the server group or the server must be specified.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-AutoExpire<SwitchParameter>
Specify the AutoExpire parameter to allow the rollback to expire automatically when the history log advances past the restore point (point-in-time of the rollback). When the history log advances past the restore point, the rollback will expire without warning and be permanently unusable and should be deleted, see Remove-DcsRollback.If not specified, the rollback will persist until it is deleted or split. (An exception to this is when a marker is created. In this case, the marker will automatically expire by default. See TimeSpan parameter description.) WARNING: Keeping a rollback persistent can have ramifications. When the history log advances past the restore point, a mirrored virtual disk will have compromised mirror redundancy and a single virtual disk will become inaccessible. The rollback will have to be deleted or split to allow writes to the CDP-enabled virtual disk again.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-DuplicateDiskId<SwitchParameter>
Specify this parameter only if both the CDP-enabled virtual disk and the rollback will be served to client hosts that require the same SCSI inquiry ID (virtual product information).

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-TimeStamp<DateTime>
The date and time of the rollback. The rollback will become a logical representation of the virtual disk data at the specified date and time (restore point). Use either the Timestamp parameter or the TimeSpan parameter to specify the restore point. One way to provide the TimeStamp parameter would be by piping a variable created by invoking New-Object with the TypeName parameter of DateTime with the correct arguments (see Help for New-Object, Get-Date). The TimeStamp parameter can also be provided in a string with the date and time. An example of the format to use is "Tuesday, March 29, 2011 2:51:00 PM".

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-AssignToCurrentUser<SwitchParameter>
Use this parameter to assign exclusive ownership to the user account currently logged in. This restricts all operations on the rollback being created to only the authenticated user for the current PowerShell session.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-TimeSpan<TimeSpan>
TimeSpan is the amount of negative elapsed time used to represent the date and time of the rollback. Use either the Timestamp parameter or the TimeSpan parameter to specify the restore point.One way to provide the TimeSpan parameter would be using a variable piped from invoking New-Object with the TypeName parameter of TimeSpan with the correct arguments (see the Help for New-Object). The TimeSpan parameter can also be provided in a string that represents the number of days, hours, minutes, and seconds in the past. For instance, if the rollback should be created using the data as it existed 1 day, 12 hours, 30 minutes ago, the value would be "01.12:30:00" and this must be in quotes. A TimeSpan with the value of "0" (which means now) will create a special rollback that can be used as a marker. In this special case and only in this case, after the cmdlet is invoked, the cache will be flushed on the DataCore Server before creating the rollback. To create a rollback with consistent application data, perform an application-specific flush and quiesce on the client host before invoking the cmdlet. The default behavior for the marker is to automatically expire. See example 4.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-VirtualDiskGroup<Object>
VirtualDiskGroupData object, name or ID that identifies a virtual disk group. The object can be obtained using Get-DcsVirtualDiskGroup. This parameter is used to create a rollback group from a virtual disk group. The rollback group will be named using the virtual disk group name with the timestamp appended. For example, if the virtual disk group is named VDGroup1 and the timestamp is 11/2/2011 2:45:19 PM, then the snapshot group name would be named "VDGroup1 @ 11/2/2011 2:45:19 PM".

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

VirtualDiskData or VirtualDiskGroupData : Object that identifies and describes the virtual disk or virtual disk group.

OUTPUTS

RollbackData or RollbackGroupData : Object that identifies and describes the rollback or the rollback group that was created.

NOTES

Also see Remove-DcsRollback, Get-DcsRollback, Revert-DcsRollback, Split-DcsRollback, Get-DcsVirtualDisk, Get-DcsVirtualDiskGroup, Get-DcsRollbackGroup, Remove-DcsRollbackGroup.

EXAMPLES

-------------- Example 1 Creates a rollback using a timestamp --------------

Add-DcsRollback -Server SSV1 -VirtualDisk "virtual disk 5" -Name VDisk5RB3 -Pool SSV1Pool3 -AutoExpire -TimeStamp "Thursday, July 28, 2011 01:08:00 PM"

Creates a rollback of the virtual disk named "Virtual Disk 5" from the pool named "SSV1Pool3" on the server named "SSV1". The rollback is named "VDisk5RB3" and is an image of the data on Thursday, July 28, 2011 at 1:08 AM and will expire automatically when the restore point reaches the end of the history log. The RestorePoint field in the returned object is displayed in UTC.

SourceLogicalDiskId : LD:74EDD1B3-6682-46A7-943C-2F0168CEC699_V.{267e5c50-abd6-11e0-9515-00155d11e921}-00000018
DestinationLogicalDiskId : LD:74EDD1B3-6682-46A7-943C-2F0168CEC699_V.{b96878da-b7af-11e0-9ba8-00155d11e921}-00000009
RestorePoint : 7/28/2011 5:08:00 PM
AutoExpire : True
State : Unknown
Id : V.{267E5C50-ABD6-11E0-9515-00155D11E921}-00000018--V.{B96878DA-B7AF-11E0-9BA8-00155D11E921}-00000009
Caption : VDisk5RB3
ExtendedCaption : VDisk5RB3 on SSV1
Internal : False
     

-------------- Example 2 Creates a rollback group --------------

Add-DcsRollback -Server SSVVM1 -VirtualDiskGroup VDgroup1 -Pool "Disk pool 1" -AutoExpire -TimeStamp "Thursday, November 3, 2011 4:00:00 PM"

Creates a rollback group for the virtual disk group named "VDgroup1" from the pool named "Disk pool 1" on the server named "SSVVM1". The rollback group is named "VDgroup1 @ 11/3/2011 4:07:57 PM" (which is the time that the group was created). The rollback group contains a rollback for each virtual disk in the group. Those rollbacks are an image of the data on Thursday, November 3, 2011 at 4:00 PM and will expire automatically when the restore point reaches the end of the history log.

ParentGroupId : {827c0546-a101-4115-8a8f-b07ab87272dd}
Alias : VDgroup1 @ 11/3/2011 4:07:57 PM
Description :
Id : {33b3686c-06e2-4067-9c2e-aca0f794d4ec}
Caption : VDgroup1 @ 11/3/2011 4:07:57 PM
ExtendedCaption :
Internal : False
     

-------------- Example 3 Creates a rollback group using a time span --------------

Add-DcsRollback -Server SSVVM1 -VirtualDiskGroup VDgroup1 -Pool "Disk pool 1" -AutoExpire -TimeSpan "00.00:30:00"

Creates a rollback group for the virtual disk group named "VDgroup1" from the pool named "Disk pool 1" on the server named "SSVVM1". The rollback group is named "VDgroup1 @ 11/3/2011 4:45:24 PM" (which is the time that the group was created). The rollback group contains a rollback for each virtual disk in the group. The rollbacks are an image of the data on as it was 30 minutes in the past. The rollbacks will expire automatically when the restore point reaches the end of the history log.

ParentGroupId : {827c0546-a101-4115-8a8f-b07ab87272dd}
Alias : VDgroup1 @ 11/3/2011 4:45:24 PM
Description :
Id : {b807ccec-4b97-400e-8936-0b9d98d09788}
Caption : VDgroup1 @ 11/3/2011 4:45:24 PM
ExtendedCaption :
Internal : False
     

-------------- Example 4 Creates a special rollback marker --------------

Add-DcsRollback -Server SSV1 -VirtualDisk "Virtual disk 1" -Name VDisk1RBMarker1 -Pool "Disk pool 1" -AutoExpire -TimeSpan 0

Creates a special rollback marker of the virtual disk named "Virtual disk 1" from the pool named "Disk pool 1" on the server named "SSV1". The rollback is named "VDisk1RBMarker1". When the cmdlet is invoked, the cache is flushed on the server SSV1 and then the rollback is created on SSV1. The rollback will expire automatically when the restore point reaches the end of the history log. The RestorePoint field in the returned object is the timestamp when the rollback was created on the server SSV1 and is displayed in UTC.

SourceLogicalDiskId : e75bf8bd-6dc4-4237-a867-5d4844f87355
DestinationLogicalDiskId : c928faa7-15e3-4c9d-ac6d-49d55bcd0f18
RestorePoint : 9/16/2014 5:11:34 PM
AutoExpire : True
State : Unknown
SequenceNumber : 1114
Id : V.{378327E6-3D98-11E4-BD80-00155D651603}-00000001--V.{378327E6-3D98-11E4-BD80-00155D651603}-00000003
Caption : VDisk1RBNOW
ExtendedCaption : VDisk1RBNOW on SSV1
Internal : False
     

To Table of Contents

NAME

Add-DcsServer

SYNOPSIS

Adds a server to an existing server group.

SYNTAX

Add-DcsServer   -Server <String>   [ -DisableLogin]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Adds a server to an existing server group. Two servers in a group enables mirroring and high availability.

PARAMETERS

-Server<String>
Computer name or IP address of the server to be added to the server group. The computer name must be unique or the name must be fully qualified.

Required: true
Position: 1
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-DisableLogin<SwitchParameter>
By default, iSCSI ports are automatically logged in when a server is added to a server group. Specify this parameter to prevent automatic login in order to selectively login the iSCSI ports manually.

Required: false
Position: 2
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias representing the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

ServerHostData : Object that identifies the server.

NOTES

Also see Remove-DcsServer, Get-DcsServer.

EXAMPLES

-------------- Example 1 Adds a server to the server group --------------

Add-DcsServer -Server "SSVVM03" -DisableLogin -Connection "Commect1"

Adds a server named "SSVVM03" to the server group that uses the connection named "Connect1". Automatic login of ports is disabled.

GroupId : 01b849ad-54b9-413b-9654-dc4eface5c40
RegionNodeId : ExecutiveNode:2955B0EE-D2A5-4162-97E5-E99CEBE933E7
CacheSize : 0 B
State : NotPresent
SupportState : NotPresent
SnapshotMapStoreId :
SnapshotMapStorePoolId :
InstallPath :
ProductName :
ProductType :
ProductVersion :
OsVersion :
ProcessorInfo :
ProductBuild :
BuildType :
DiagnosticMode : Disabled
LicenseRemaining : -9223372036854775808
ReplicationBufferFolder :
TotalSystemMemory : 0 B
AvailableSystemMemory : 0 B
LogStatus : Operational
LicenseSettings : DataCore.Executive.LicenseSettings
IsLicensed : False
LicenseExceeded : False
StorageUsed : 0 B
BulkStorageUsed : 0 B
DataCoreStorageUsed : 0 B
DataCoreBulkStorageUsed : 0 B
PowerState : Unknown
CacheState : Unknown
BackupStorageFolder :
IpAddresses : {}
LicenseNumber : 2509912577132288407
AluaGroupId : 2
IsVirtualMachine : False
HypervisorHostId :
LogStorePoolId :
Description :
HostName : SSVVM03.datacoresoftware.com
MpioCapable : True
SequenceNumber : 2066386
Id : 2955B0EE-D2A5-4162-97E5-E99CEBE933E7
Caption : SSVVM03
ExtendedCaption : SSVVM03 in Server Group 1
Internal : False
     

To Table of Contents

NAME

Add-DcsSnapshot

SYNOPSIS

Creates a snapshot of a virtual disk. This operation can also be performed on a virtual disk group, which creates a snapshot group.

SYNTAX

Add-DcsSnapshot   [ -Server <String> ]   -VirtualDisk <Object>   [ -Name <String> ]   [ -Pool <String> ]   [ -Full]   [ -Description <String> ]   [ -DuplicateDiskId]   [ -AssignToCurrentUser]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsSnapshot   [ -Server <String> ]   -VirtualDiskGroup <Object>   [ -Name <String> ]   [ -Pool <String> ]   [ -Full]   [ -Description <String> ]   [ -DuplicateDiskId]   [ -AssignToCurrentUser]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Creates a snapshot of a virtual disk. This operation can also be performed on a virtual disk group, which creates a snapshot group. The snapshots created can be different or full images. A mapstore must be set before invoking this cmdlet, see Set-DcsSnapshotMapStore.

PARAMETERS

-Server<String>
Computer name or ID of the server where the snapshot should be created. The computer name must be unique or the name must be fully qualified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-VirtualDisk<Object>
VirtualDiskData object, name, or ID that identifies the virtual disk to be used as the source of the snapshot.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Name<String>
Name to assign to the snapshot. If not specified a default name will be assigned. The default name will consist of the name of the source virtual disk and timestamp of when the snapshot is created.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Pool<String>
Name or ID of the pool to use to create the snapshot. To resolve by name, the name must be unique to the server group or the server must be specified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Full<SwitchParameter>
Specify this parameter to create a snapshot that is a clone copy of the source and can exist and operate independently from the source virtual disk. If this parameter is not specified, a differential snapshot will be created. A differential snapshot is a logical image that is dependent on the source virtual disk.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Description<String>
Description of the snapshot.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-DuplicateDiskId<SwitchParameter>
Specify this parameter only if both the source virtual disk and the snapshot will be served to client hosts that require the same SCSI inquiry ID (virtual product information).

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-AssignToCurrentUser<SwitchParameter>
Use this parameter to assign exclusive ownership to the user account currently logged in. This restricts all operations on the snapshot being created to only the authenticated user for the current PowerShell session.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-VirtualDiskGroup<Object>
VirtualDiskGroupData object, name or ID that identifies a virtual disk group. The object can be obtained using Get-DcsVirtualDiskGroup. This parameter is used to create a snapshot group from a virtual disk group. The snapshot group will be named using the virtual disk group name with the timestamp appended. For example, if the virtual disk group is named VDGroup1 and the timestamp is 11/2/2011 2:45:19 PM, then the snapshot group name would be "VDGroup1 @ 11/2/2011 2:45:19 PM".

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

VirtualDiskData : Object that identifies and describes the virtual disk.

OUTPUTS

SnapshotData or SnapshotGroupData : Object that identifies and describes the snapshot or the snapshot group.

NOTES

Also see Set-DcsSnapshotMapStore, Update-DcsSnapshot, ConvertTo-DcsFullSnapshot, Revert-DcsSnapshot, Remove-DcsSnapshot, Get-DcsSnapshot, Get-DcsVirtualDisk, Get-DcsVirtualDiskGroup, Get-DcsSnapshotGroup, Remove-DcsSnapshotGroup.

EXAMPLES

-------------- Example 1 Creates a full snapshot --------------

Add-DcsSnapshot -Server SSV1 -VirtualDisk "Virtual Disk 2" -Pool SSV1Pool3 -Full -Description "Virtual Disk 2 Nightly Backup"

Creates a full (clone copy) snapshot of the virtual disk named "Virtual Disk 2". The snapshot is created from the disk pool named "SSV1Pool3" on the server named "SSV1". The description is set to "Virtual Disk 2 Nightly Backup". The snapshot name will be the default name "Virtual disk 2 @ 7/27/2011 2:09:11 PM" (virtual disk name with the timestamp of when the snapshot was created).

SourceLogicalDiskId : LD:74EDD1B3-6682-46A7-943C-2F0168CEC699_V.{267e5c50-abd6-11e0-9515-00155d11e921}-00000014
DestinationLogicalDiskId : LD:74EDD1B3-6682-46A7-943C-2F0168CEC699_V.{b96878da-b7af-11e0-9ba8-00155d11e921}-00000004
Type : Full
TimeStamp : 7/27/2011 2:09:13 PM
ActiveOperation : NoOperation
State : Creating
Failure : NoFailure
Id : V.{267E5C50-ABD6-11E0-9515-00155D11E921}-00000014--V.{B96878DA-B7AF-11E0-9BA8-00155D11E921}-00000004
Caption : Virtual disk 2 @ 7/27/2011 2:09:11 PM
ExtendedCaption : Virtual disk 2 @ 7/27/2011 2:09:11 PM on SSV1
Internal : False
     

-------------- Example 2 Creates a full snapshot for a virtual disk group --------------

Add-DcsSnapshot -Server SSVVM1 -VirtualDiskGroup VDgroup1 -Pool "Disk pool 1" -Full

Creates a full (clone copy) snapshot of the virtual disk group named "VDgroup1". The snapshot is created from the disk pool named "Disk pool 1" on the server named "SSVVM1". The snapshot name will be the default name "VDgroup1 @ 11/3/2011 4:25:48 PM" (virtual disk group name with the timestamp of when the snapshot group was created).

ParentGroupId : {827c0546-a101-4115-8a8f-b07ab87272dd}
Alias : VDgroup1 @ 11/3/2011 4:25:48 PM
Description :
SequenceNumber : 11725
Id : {02685559-ba03-4cb5-a346-f79fc2d62765}
Caption : VDgroup1 @ 11/3/2011 4:25:48 PM
ExtendedCaption :
Internal : False
     

To Table of Contents

NAME

Add-DcsStorageProfile

SYNOPSIS

Creates a custom storage profile.

SYNTAX

Add-DcsStorageProfile   -Name <String>   [ -Description <String> ]   [ -PerformanceClass <PerformanceClass> ]   [ -ReplicationPriority <AsyncReplicationPriority> ]   [ -MirrorRecoveryPriority <MirrorRecoveryPriority> ]   [ -WriteTracking <Boolean> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Creates a custom storage profile.

PARAMETERS

-Name<String>
Name of the storage profile being created.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Description<String>
Description of the storage profile being created.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PerformanceClass<PerformanceClass>
The performance class to assign to the storage profile. Valid values include "Archive", "Low", "Normal", "High", and "Critical". If not specified, the default setting "Normal" will be assigned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-ReplicationPriority<AsyncReplicationPriority>
The replication priority to assign to the storage profile. Valid values include "Low", "Regular", "High", and "Critical". If not specified, the default setting "Regular" will be assigned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-MirrorRecoveryPriority<MirrorRecoveryPriority>
The mirror recovery priority to assign to the storage profile. Valid values include "Low", "Regular", "High", and "Critical". (The value "Unset" is for DataCore internal use only.) If this parameter is not specified, the default setting "Regular" will be assigned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-WriteTracking<Boolean>
Use this parameter to specify whether or not to include write operations when determining the data temperature in the auto-tiering feature. Specify $true to have auto-tiering determine data temperature based on both read and write operations equally. Specify $false to have auto-tiering determine data temperature based on read operations only.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

StorageProfileData : Object that identifies and describes the storage profile.

NOTES

Also see Set-DcsStorageProfileProperties, Remove-DcsStorageProfile, Get-DcsStorageProfile.

EXAMPLES

-------------- Example 1 Creates custom storage profile --------------

Add-DcsStorageProfile -Name PF_Billing -Description "Profile for Finance Dept billing records" -MirrorRecoveryPriority critical -WriteTracking $true

A custom storage profile named "PF_Billing" is created with a description of "Profile for Finance Dept billing records. The value for the parameter MirrorRecoveryPriority is assigned as "critical". The parameters PerformanceClass and ReplicationPriority were not set, so the default values are assigned. Write tracking is enabled. The StorageProfileData object for the new storage profile is returned.

Alias : PF_Billing
Description : Profile for Finance Dept billing records
PerformanceClass : Normal
ReplicationPriority : Regular
RecoveryPriority : Critical
WriteTracking : True
DefaultProfile : False
SequenceNumber : 22986
Id : 6b83a780-e607-4167-a7dc-92e2c45962a9
Caption : PF_Billing
ExtendedCaption : PF_Billing Profile
Internal : False
     

To Table of Contents

NAME

Add-DcsTask

SYNOPSIS

Creates a task used to perform actions automatically when triggered by events.

SYNTAX

Add-DcsTask   -Name <String>   [ -Description <String> ]   [ -ActionDelay <TimeSpan> ]   [ -RequireAllTriggers]   [ -Disabled]   [ -MaxRunTime <TimeSpan> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Creates a task used to perform actions automatically when events are triggered. This cmdlet creates the task and sets properties of the task. Add a trigger to the task with Add-DcsTrigger. Add an action to the task with Add-DcsAction. Properties of the task can be set with Set-DcsTaskProperties.

PARAMETERS

-Name<String>
Name to assign to the task.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Description<String>
Description of the task.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-ActionDelay<TimeSpan>
Use this parameter to set the amount of time to wait before performing actions when triggers are signaled. The format of this parameter consists of decimals representing hours, minutes, and seconds. For instance, 01:05:30 would represent a delay of 1 hour, 5 minutes and 30 seconds. The maximum value must be less than 2 hours. The default value is 0.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-RequireAllTriggers<SwitchParameter>
This parameter indicates whether to run the task when one trigger is met or to wait until all triggers are met. If specified, the task will only run when all triggers are met.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Disabled<SwitchParameter>
Specify this parameter to disable the task. The task will not run until it is enabled (see Enable-DcsTask). If not specified, the task will be enabled.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-MaxRunTime<TimeSpan>
The amount of time allotted to perform all actions for each instance that the task is run. The time is shared by all actions in the task. When the time has been reached, all actions will be terminated. If triggered again, the same time will be allotted to perform the actions again. The format of this parameter consists of decimals representing days, hours, minutes, and seconds, that are separated by colons. For instance, 01:05:30:00 would represent a maximum run time of 1 day, 5 hours and 30 minutes. The maximum value is 7 days. If this parameter is not specified, the default setting of 7 days (7:00:00:00) will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

TaskData : Object that identifies and describes the task.

NOTES

Also see Add-DcsTrigger, Add-DcsAction, Remove-DcsTask, Get-DcsTask, Set-DcsTaskProperties.

EXAMPLES

-------------- Example 1 Creates a task with an action delay and requiring all triggers --------------

Add-DcsTask -Name MyNightlyTask -Description 'Start Virtual Disk Reclamation at 2 am' -ActionDelay 01:05:30 -RequireAllTriggers

Adds a task named "MyNightlyTask" and set the ActionDelay for 1 hour, 5 minutes and 30 seconds. All triggers must be tripped before actions will be performed.

Description : Start Virtual Disk Reclamation at 2 am
Enabled : True
ActionBehavior : RunInBatchMode
MaxRunTime : 6048000000000
Connective : LogicalAnd
ActionDelay : 39300000000
State : Idle
CurrentActionId :
LastStartTime : 1/1/0001 12:00:00 AM
LastStopTime : 1/1/0001 12:00:00 AM
Id : 00380dca-5084-49b1-9568-202eced2e79a
Caption : MyNightlyTask
ExtendedCaption : MyNightlyTask
Internal : False
     

To Table of Contents

NAME

Add-DcsTrigger

SYNOPSIS

Creates a trigger for the specified task.

SYNTAX

Add-DcsTrigger   -Task <Object>   [ -Description <String> ]   -SignalDuration <TimeSpan>   -StartTime <DateTime>   -Interval <TimeSpan>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsTrigger   -Task <Object>   [ -Description <String> ]   -SignalDuration <TimeSpan>   -StartTime <DateTime>   -WeekDays <String[]>   -WeekInterval <Int32>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsTrigger   -Task <Object>   [ -Description <String> ]   -SignalDuration <TimeSpan>   -StartTime <DateTime>   -DayInterval <Int32>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsTrigger   -Task <Object>   [ -Description <String> ]   -SignalDuration <TimeSpan>   -StartTime <DateTime>   [ -MonthNumber <Int32> ]   -DayOfMonth <Int32>   -MonthlyInterval <Int32>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsTrigger   -Task <Object>   [ -Description <String> ]   -SignalDuration <TimeSpan>   -StartTime <DateTime>   [ -MonthNumber <Int32> ]   -WeekDays <String[]>   -MonthlyInterval <Int32>   -WeekNumber <Int32>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsTrigger   -Task <Object>   [ -Description <String> ]   -MonitorId <String>   -MonitorState <String>   -Comparison <String>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsTrigger   -Task <Object>   [ -Description <String> ]   -TemplateTypeId <String>   -MonitorState <String>   -Comparison <String>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsTrigger   -Task <Object>   [ -Description <String> ]   -FilterType <String[]>   -FilterValue <String[]>   -FilterComparison <String[]>   -RequireAll <Boolean>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsTrigger   -Task <Object>   [ -Description <String> ]   -VirtualDisk <String>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Creates a trigger for the specified task. A trigger contains criteria that, when met, causes the task actions to be performed (see Add-DcsAction). One trigger can be added to the task each time the cmdlet is invoked.The trigger will be based on one of the following types of events: a scheduled time, a monitor state change, a message posted in the event log, or a replication checkpoint being received. There are several parameter sets for this cmdlet; five for scheduled time events, two for a monitor state change event, one for a log message event, and one for a replication checkpoint event. When creating a trigger for a log message event, filters are used to narrow the scope of the log messages. If multiple filters are configured, the number of values specified for FilterType, FilterValue, and FilterComparison parameters in the array must be identical and in an associated order. See example 7.

PARAMETERS

-Task<Object>
TaskData object, ID, or name of the task that the trigger will be added to.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Description<String>
The description parameter has been deprecated and will always be empty. This parameter is left in the interface for backwards compatibility. It cannot be changed.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-SignalDuration<TimeSpan>
This parameter indicates how long the trigger will be considered active. If not specified, the default value of "00:00:00" will be used, which indicates no signal duration setting. This parameter is only relevant when multiple triggers exist, and the RequireAllTriggers parameter set to $true in Add-DcsTask. For example, if one trigger is set to run once at 8PM and another scheduled time trigger in the same task is set to run hourly and the SignalDuration parameter is set to 12 hours, then the action would run 12 times starting at 8PM. One way to provide the SignalDuration parameter would be by passing a variable created from invoking New-Object with the TypeName parameter of TimeSpan with the correct arguments (see the Help for New-Object). The TimeSpan parameter can also be provided in a string that represents the number of days, hours, and minutes in this format: "dd:dd:dd". This value does not require quotes. For instance, to keep the triggers active for one week, the value would be "07:00:00" or to keep the triggers active for 12 hours, the value would be "00:12:00".

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-StartTime<DateTime>
The beginning date and time of a scheduled time trigger. One way to provide the StartTime parameter would be by passing a variable created by invoking New-Object with the TypeName parameter of DateTime with the correct arguments (see the Help for New-Object, Get-Date). The StartTime parameter can also be provided in a string with the date and time. An example of the format to use is "04/06/2011 02:51:00 PM" which represents April 6, 2011 at 2:51 PM. This value must be in quotes.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Interval<TimeSpan>
When creating a scheduled time event, this parameter is used to indicate the amount of time in hours, minutes, seconds to wait between triggering the event again. The format to use is dd:dd:dd. This value does not require quotes. For instance, "02:15:30" would represent that the scheduled time event to occur every 2 hours, 15 minutes and 30 seconds. Use "00:00:00" to not set an interval.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-WeekDays<String[]>
When creating a scheduled time event based on specific days of the week, this parameter uses an array of the days on which the event will occur. Possible values are: "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday", and "Weekdays". The "Weekdays" value is exclusive; when "Weekdays" is used, then no other day is valid. For instance, for a scheduled time event to run Monday through Friday, the parameter value would be "Weekdays". For a scheduled time event to run Monday, Wednesday, and Friday, the parameter value would be "Monday", "Wednesday", "Friday".

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-WeekInterval<Int32>
When creating a weekly scheduled time event based on the WeekDays parameter, the WeekInterval indicates how many weeks are in-between each firing of the event. For example: A value of "1" indicates that the event will occur every week. A value of "2" indicates that the event will occur every two weeks (or every other week). A value of "3" indicates that the event will occur every three weeks.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-DayInterval<Int32>
When creating a scheduled time event, this parameter is used to indicate how often, in terms of days, that the event should be triggered. For example: To trigger the event every day, use "1". To trigger the event to run every two days (or every other day), use "2". To trigger the event every seven days, use "7".

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-MonthNumber<Int32>
When creating a yearly scheduled time event, this parameter is used to signify the number of the month on which event will occur. For instance, January would be "1" and December would be "12". If MonthNumber and MonthlyInterval are both set, MonthNumber will supersede MonthlyInterval.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-DayOfMonth<Int32>
When creating a yearly or monthly scheduled time event based on the MonthNumber or MonthlyInterval parameters, the DayOfMonth parameter is used to indicate the day of the month when the event is triggered. Valid parameter values are 1 through 31. For instance a value of "2" would indicate the second day of the month.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-MonthlyInterval<Int32>
When creating a monthly scheduled time event, the MonthlyInterval parameter indicates how many months are in-between each firing of the event. For example: A value of 1 indicates that the event will occur every month. A value of 2 indicates that the event will occur every two months (or every other month). A value of 3 indicates that the event will occur every three months.(If MonthNumber and MonthlyInterval are both used in the parameter set, MonthNumber will supersede MonthlyInterval.)

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-WeekNumber<Int32>
When creating a monthly scheduled time event, this parameter signifies the number of the week in a month when the event will occur. For instance, the first week in the month would be "1" and the forth week in the month would be "4".

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-MonitorId<String>
The ID of the monitor that will trigger the event. This parameter is used to specify an instance of a specific monitor. The monitor ID is included in the MonitorData object (ID field), which can be obtained from Get-DcsMonitor. See the example 5 for more information.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-MonitorState<String>
The state that will trigger the Monitor based event. Possible values in order from lowest to highest: "Healthy", "Attention", "Warning" , and "Critical". This parameter works in conjunction with the comparison operator.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Comparison<String>
Monitor Comparison values are as follows: ">", ">=", "=", "<", and "<=".

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-TemplateTypeId<String>
The Type ID of the template used in the Monitor based trigger. This parameter is used to specify a selection of all instances of a monitor type. The template type ID is included in the MonitorDataTemplate object (TypeID field) and can be obtained from Get-DcsMonitorTemplate. See the example 6 for more information.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-FilterType<String[]>
The FilterType parameter is used to indicate what aspect of the log messages will be used to trigger the event. Potential values are: "Source", "SourceType", "MessageText", and "LogLevel". If creating multiple filters, the number of values for FilterType, FilterValue, and FilterComparison parameters must be equal and in an associated order.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-FilterValue<String[]>
The filter value that the LogMessage based trigger must contain to trigger the event. For a filter type of "Source", possible values include a string containing the name of a SAN resource. For a filter type of "SourceType", possible values include: "General", "Disk pools", "Mirrors", "Monitors", "Paths", "Physical disks", "Ports", "Replications", "Rollbacks", "Security", "Snapshots", "Hosts", "DataCore Servers", "Tasks", "Virtual disk sources", "Virtual disks", "Support", or "PerfStorage". For a filter type of "MessageText", possible values include a string from the message text field. For a filter type of "LogLevel", possible values include "Trace", "Info", "Warning", or "Error". If creating multiple filters, the number of values for FilterType, FilterValue, and FilterComparison parameters must be equal and in an associated order.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-FilterComparison<String[]>
The filter comparison value is used to compare the FilterValue to see whether the criteria have been met. Possible values are: "Contains", "DoesNotContain", "IsEqualTo", and "IsNotEqualTo". If creating multiple filters, the number of values for FilterType, FilterValue, and FilterComparison parameters must be equal and in an associated order.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-RequireAll<Boolean>
Indicates whether all Filters must be met when creating a log based event trigger.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-VirtualDisk<String>
The name or ID of the virtual disk that will receive the replication checkpoint marker.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

TaskData : Object that identifies and describes the task.

OUTPUTS

TaskTriggerData : Object that identifies and describes the task trigger.

NOTES

Also see Get-DcsTask, Get-DcsTrigger, Remove-DcsTrigger, Add-DcsTask, Get-DcsMonitor, Get-DcsMonitorTemplate.

EXAMPLES

-------------- Example 1 Adds an hourly trigger --------------

Add-DcsTrigger -Task MyHourlyTask -Interval 01:00:00  -SignalDuration 00:00:00 -StartTime "07/28/2011 11:00:00 PM"

Creates a trigger for the task named "MyHourlyTask", starting at 11 PM on July 27, 2011 (see caption). The trigger will occur every hour. No signal duration is set. The StartTime returned in the object is displayed in UTC.

Interval : 36000000000
Recurrence : TimeInterval
SignalDuration : 0
StartTime : 7/29/2011 3:00:00 AM
TaskId : c122c331-f334-437f-a176-db9d3053ab4f
Type : ScheduledTrigger
Description :
Id : a9125ed8-514c-48e8-9521-2dbb3c7d4f19
Caption : Every 01:00:00, starting on 7/28/2011 11:00:00 PM
ExtendedCaption :
Internal : False
     

-------------- Example 2 Adds a trigger that will occur every three days --------------

Add-DcsTrigger -Task MyTask -SignalDuration 00:00:00 -StartTime "10/18/11 11:45:00 AM" -DayInterval 3

Creates a trigger for the task named "MyTask", starting at 11:45 AM on October 18, 2011. The trigger will occur every three days. No signal duration is set. The StartTime returned in the object is displayed in UTC.

Weekdays : False
DailyInterval : 3
Recurrence : Daily
SignalDuration : 0
StartTime : 10/18/2011 3:45:00 PM
TaskId : 0049e781-b588-4019-b43d-3f88925dbbd4
Type : ScheduledTrigger
Description :
Id : f377926e-3361-44e4-9fe9-0882af0f6140
Caption : Every 3 days at 11:45:00, starting on 10/18/2011 11:45:00 AM
ExtendedCaption :
Internal : False
     

-------------- Example 3 Adds a trigger to run specific days of every week --------------

Add-DcsTrigger -Task MyTask -SignalDuration 00:00:00 -StartTime "10/18/11 1:00:00 PM" -WeekDays "Monday", "Wednesday", "Friday" -WeekInterval 1

Creates a trigger for the task named "MyTask", starting at 1:00 PM on October 18, 2011. The trigger will occur Monday, Wednesday, and Friday of every week. No signal duration is set. The StartTime returned in the object is displayed in UTC.

WeeklyInterval : 1
WeekdaySelection : Monday, Wednesday, Friday
Recurrence : Weekly
SignalDuration : 0
StartTime : 10/18/2011 5:00:00 PM
TaskId : 0049e781-b588-4019-b43d-3f88925dbbd4
Type : ScheduledTrigger
Description :
Id : 8de47e2d-0cb5-4a1c-a1b8-016c9883218e
Caption : Once every 1 week at 13:00:00 starting on 10/18/2011 1:00:00 PM, on these days only: Mon Wed Fri
ExtendedCaption :
Internal : False
     

-------------- Example 4 Adds a trigger for a replication checkpoint received --------------

Add-DcsTrigger -Task MyTask -VirtualDisk "Virtual disk 2"

Creates a replication checkpoint trigger for the task named "MyTask". The trigger will occur when the virtual disk named "Virtual disk 2" receives a checkpoint marker.

VirtualDiskDataId : 396397105a7a4094949f33adce4c2fb1
TaskId : 0049e781-b588-4019-b43d-3f88925dbbd4
Type : CheckpointTrigger
Description :
Id : dca2bad428f3428cabf36acca28dda7a
Caption : Checkpoint Marker for Virtual disk 2
ExtendedCaption :
Internal : False
     

-------------- Example 5 Adds a trigger using the Monitor ID for a specific monitor instance --------------

$Monitor = Get-DcsMonitor -Object (Get-DcsClient -Client "HostVM1")

Add-DcsTrigger -Task MonitorStateChange -MonitorId $Monitor.Id -MonitorState Healthy -Comparison ">"

This example creates a trigger to monitor a specific host client for any state other than Healthy. The cmdlet Get-DcsMonitor is invoked to retrieve the MonitorData object for the host client named "HostVM1". The object is stored in the variable $Monitor. The cmdlet Add-DcsTrigger is invoked to add a trigger to the task "MonitorStateChange". The monitor ID is identified by supplying the variable $Monitor.Id (where the Id is stored). The trigger will monitor for all state greater than "Healthy", which include Attention, Warning and Critical states.

MonitoredObjectId : ClientMachineStateMonitor<8cdaebf4085b4a7fb3d53b0647cbf95e>
MonitorTemplateTypeId :
MonitorThreshold : Healthy
TriggerStateOperator : Greater
TaskId : 2aba4b9b-e48b-4ef5-9926-8984e05823c2
Type : MonitorTrigger
Description :
Active : False
SequenceNumber : 11463
Id : a5b46206-1a16-4070-8c75-fe27c2c9d7a8
Caption : State of HostVM1 > Healthy
ExtendedCaption :
Internal : False
     

-------------- Example 6 Adds a trigger using the Template ID to specify all monitor instances for a certain type --------------

Add-DcsTrigger -Task MonitorHosts -TemplateTypeId "T(DataCore.Executive.Controller.ClientMachineStateMonitor<DataCore.Executive.Controller.ClientMachine>)" -MonitorState Healthy -Comparison ">"

Creates a monitor trigger for the task named "MonitorHosts" by providing the template type ID "T(DataCore.Executive.Controller.ClientMachineStateMonitor<DataCore.Executive.Controller.ClientMachine>)" to specify all monitor instances of that type. The trigger will occur when the monitor is greater than Healthy, which includes the states Attention, Warning and Critical. The template type ID was found by invoking Get-DcsMonitorTemplate and providing the correct type ID from the returned templates.

MonitoredObjectId :
MonitorTemplateTypeId : T(DataCore.Executive.Controller.ClientMachineStateMonitor<DataCore.Executive.Controller.ClientMachine>)
MonitorThreshold : Healthy
TriggerStateOperator : Greater
TaskId : 827fec88-94cd-487d-a2d4-e3354d968f55
Type : MonitorTrigger
Description :
Id : c7e52761-2891-432f-bac7-64429259c7c9
Caption : State of Hosts > Healthy
ExtendedCaption :
Internal : False
     

-------------- Example 7 Adds a log message trigger with two filters. --------------

$Tasks = Get-DcsTask

$tasks | Add-DcsTrigger -FilterType "SourceType","LogLevel" -FilterValue "Disk pools","Warning" -FilterComparison "IsEqualTo","IsEqualTo" -RequireAll $true

The cmdlet Get-DcsTask is invoked to get all TaskData objects and stored in the variable $Tasks. (In this case, there is one task created.) The variable $Tasks is piped to cmdlet Add-DcsTrigger and the cmdlet is invoked to add a single trigger with two filters to the existing task "Task1". The first filter will be satisfied when a log message is received for any disk pool; the filter type is "SourceType", filter value is "Disk pools", and filter comparison is "IsEqualTo". The second filter will be satisfied when a log message is received for a log message at the warning level; filter type is "LogLevel", filter value is "Warning", and filter comparison is "IsEqualTo". The RequireAll parameter is set to true, which means that both filters must be satisfied, so the trigger will fire when a message is received for a disk pool that is at the warning level.

MessageFilters : {Source type = Disk pools, Log level = Warning}
Connective : LogicalAnd
TaskId : 380f189b-80dd-4a09-b0cd-f3647fb330f3
Type : MessageTrigger
Description :
SequenceNumber : 36931
Id : d757d6ea-4569-43f2-8285-4ec5d13d447d
Caption : Log messages matching [Source type = Disk pools] AND [Log level = Warning]
ExtendedCaption :
Internal : False
     

-------------- Example 8 Adds a one time scheduled trigger --------------

Add-DcsTrigger -Task "Task 1" -Interval 00:00:00 -SignalDuration 00:00:00 -StartTime "06/18/2012 15:30:00 PM"

Creates a trigger for the task named "Task 1" that occurs once (because the interval is set to zero) that occurs at 3:30 PM on June 18, 2012 (see caption). No signal duration is set. The StartTime returned in the object is displayed in UTC.

Recurrence : OneTime
SignalDuration : 0
StartTime : 6/18/2012 7:30:00 PM
TaskId : 380f189b-80dd-4a09-b0cd-f3647fb330f3
Type : ScheduledTrigger
Description :
SequenceNumber : 26431
Id : e5953632-56c8-4ff1-bdda-746141cb6031
Caption : At 3:30 PM on 6/18/2012
ExtendedCaption :
Internal : False
     

-------------- Example 9 Adds a daily weekday trigger --------------

Add-DcsTrigger -Task "Task 1" -SignalDuration 00:00:00 -StartTime "06/18/2012 15:30:00 PM" -WeekInterval 1 -WeekDays "Weekdays"

Creates a daily weekday trigger for the task named "Task 1", starting at 3:30 PM on June 18, 2012 (see caption). No signal duration is set. The WeekInterval is set to "1" and the WeekDays parameter is set to "Weekdays" so the trigger will occur every week Monday through Friday. No signal duration is set. The StartTime returned in the object is displayed in UTC.

Weekdays : True
DailyInterval : 1
Recurrence : Daily
SignalDuration : 0
StartTime : 6/18/2012 7:30:00 PM
TaskId : 380f189b-80dd-4a09-b0cd-f3647fb330f3
Type : ScheduledTrigger
Description :
SequenceNumber : 26474
Id : 6672488b-bf18-4774-a06a-e877a9bd6e24
Caption : Every weekday at 3:30 PM starting on 6/18/2012
ExtendedCaption :
Internal : False
     

-------------- Example 10 Adds a monthly trigger on a specified day of the month --------------

Add-DcsTrigger -Task "Task 1" -SignalDuration 00:00:00 -StartTime "06/18/2012 14:00:00 PM" -MonthlyInterval 1 -DayOfMonth "15"

Creates a trigger for the task named "Task 1". The MonthlyInterval parameter is set to "1" and the DayOfMonth parameter is set to "15" so the trigger occurs every month on the 15th day of the month. The trigger starts at 2PM on June 18, 2012 (see caption). No signal duration is set. The StartTime returned in the object is displayed in UTC.

MonthlyByDateFlag : True
MonthIntervalByDayNumber : 1
DayNumberInMonth : 15
DayOfWeekInMonthlyByWeek : Sunday
WeekNumInMonthlyByWeek : 0
MonthIntervalByWeek : 0
Recurrence : Monthly
SignalDuration : 0
StartTime : 6/18/2012 6:00:00 PM
TaskId : 380f189b-80dd-4a09-b0cd-f3647fb330f3
Type : ScheduledTrigger
Description :
SequenceNumber : 26504
Id : 300729ca-e219-4e24-aea6-d6701504224a
Caption : On the 15th day of every month at 2:00 PM starting on 6/18/2012
ExtendedCaption :
Internal : False
     

-------------- Example 11 Adds a yearly trigger for a specific month and day --------------

Add-DcsTrigger -Task "Task 1" -SignalDuration 00:00:00 -StartTime "06/18/2012 20:00:00 PM" -MonthNumber 1 -DayOfMonth "15" -MonthInterval 12

Creates a trigger for the task named "Task 1". The MonthNumber is set to "1", the DayOfMonth is set to "15", and the MonthInterval is set to "12" or every 12 months, so the trigger occurs yearly every January 15th. The trigger starts at 2PM on June 18, 2012 (see caption). No signal duration is set. The StartTime returned in the object is displayed in UTC.

YearlyByDateFlag : True
YearlyByDateMonth : 1
YearlyByDateDay : 15
YearlyWeek : 0
YearlyDayOfWeek : Sunday
YearlyMonth : 0
Recurrence : Yearly
SignalDuration : 0
StartTime : 6/19/2012 12:00:00 AM
TaskId : 380f189b-80dd-4a09-b0cd-f3647fb330f3
Type : ScheduledTrigger
Description :
SequenceNumber : 26728
Id : 17348b39-67f7-4f65-a313-aa6d9b812ce8
Caption : Every year on the 15th day of January at 8:00 PM starting on 6/18/2012
ExtendedCaption :
Internal : False
     

To Table of Contents

NAME

Add-DcsUser

SYNOPSIS

Registers a user in order to access the software.

SYNTAX

Add-DcsUser   -Name <String>   [ -Email <String> ]   [ -Description <String> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Registers a user in order to access the software. After the user is registered, add roles to assign privilege level, see Add-DcsUserRole.

PARAMETERS

-Name<String>
Name of the user to register. Operating system credentials are used to authenticate users. User names must match Windows user accounts and must reside on all servers in the local server group. Credentials can be domain-wide or local (workgroup). If credentials are domain-wide, include the domain with the name for example: DOMAIN\user name.)

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Email<String>
Email address of the user. The address may used to send email notifications in other cmdlets.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Description<String>
Description of the user.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

UserData : Object that identifies and describes the user.

NOTES

Also see Add-DcsUserRole, Get-DcsUserRole, Get-DcsUser, Remove-DcsUser

EXAMPLES

-------------- Example 1 Registers a user with description and email address --------------

Add-DcsUser -Name "Jane Doe" -Email jane.doe@acme.com -Description "Storage Administrator"

Registers the user named "Jane Doe" with an email address of "jane.doe@acme.com" and a description of this user "Storage Administrator".

Name : Jane Doe
Description : Storage Administrator
EmailAddress : jane.doe@acme.com
BlendedPrivileges :
IsAdministrator : False
RoleIds : {}
Id : 08538d5d-2b16-4dc2-a948-810adbcdfedc
Caption : Jane Doe
ExtendedCaption : Jane Doe
Internal : False
     

To Table of Contents

NAME

Add-DcsUserOwnership

SYNOPSIS

Assigns ownership of a virtual disk to a user.

SYNTAX

Add-DcsUserOwnership   -User <Object>   -Object <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Assigns ownership of a virtual disk to a user. Ownership of a virtual disk grants the user authorization to perform operations on the virtual disk.

PARAMETERS

-User<Object>
UserData object or ID that identifies the user. The object and ID can be obtained from Get-DcsUser.

Required: true
Position: 1
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Object<Object>
The VirtualDiskData object or ID the identifies the virtual disk in the configuration. The object or ID can be obtained from the cmdlet Get-DcsVirtualDisk.

Required: true
Position: 2
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

VirtualDiskData : Object that identifies and describes a virtual disk.

OUTPUTS

OwnershipData : Object that identifies and describes an ownership relationship between a user and a virtual disk.

NOTES

Also see Get-DcsUserOwnership, Remove-DcsUserOwnership, Get-DcsVirtualDisk, Get-DcsUser.

EXAMPLES

-------------- Example 1 Assigns ownership using objects --------------

Get-DcsVirtualDisk -VirtualDisk "Virtual disk 1" | Add-DcsUserOwnership -User (Get-DcsUser -User "JSchmoe")

This example assigns ownership of "Virtual disk 1" to the user named "JSchmoe". The value for the parameter Object is obtained from the Get-DcsVirtualDisk cmdlet with the name of the virtual disk. The VirtualDiskData object is piped to the Add-DcsUserOwnership cmdlet. The value for the parameter User is obtained from the cmdlet Get-DcsUser to get the UserData object for the user named "Schmoe" The OwnershipData object is returned.

UserId : 39cb3daf-5d18-42ba-a3a9-13e5c3782c8a
IdentifiableId : a354eee825cb408a9a4858323d301ae3
SequenceNumber : 4102
Id : 9f9332a1-675c-4786-b570-f953bd45dbe9
Caption :
ExtendedCaption :
Internal : False
     

-------------- Example 2 Assigns ownership using IDs. --------------

Add-DcsUserOwnership -User (Get-DcsUser -User "JSchmoe").Id -Object (Get-DcsVirtualDisk -VirtualDisk "Virtual disk 2").Id

This example assigns ownership of "Virtual disk 2" to the user named "JSchmoe".
The ID value for the parameter User is obtained from the UserData object returned from the cmdlet Get-DcsUser for the user named "Schmoe" The ID value for the parameter Object is obtained from the VirtualDiskData object returned from the Get-DcsVirtualDisk cmdlet for "Virtual disk 2". The OwnershipData object is returned.
UserId : 39cb3daf-5d18-42ba-a3a9-13e5c3782c8a
IdentifiableId : 704da63e20ad4eaaa9e4701bb7bc5fbc
SequenceNumber : 4104
Id : 97404981-9e0d-48bd-8ed8-5994f753125e
Caption :
ExtendedCaption :
Internal : False
     

To Table of Contents

NAME

Add-DcsUserRole

SYNOPSIS

Adds a role to a user in order to assign the privilege level.

SYNTAX

Add-DcsUserRole   -User <Object>   -Role <String>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Adds a role to a user in order to assign the privilege level.

PARAMETERS

-User<Object>
UserData object, user name, or ID that identifies the user.

Required: true
Position: 1
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Role<String>
Name or ID that identifies the role to assign to the user. Possible roles include the predefined roles "Full Privileges", "View", and "VVol Managers", as well as any custom role. User roles can be obtained with Get-DcsUserRole.

Required: true
Position: 2
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

UserData : Object that identifies and describes the user.

OUTPUTS

UserData : Object that identifies and describes the user.

NOTES

Also see related cmdlets: Get-DcsUser, Get-DcsUserRole, Remove-DcsUserRole, Add-DcsRole.

EXAMPLES

-------------- Example 1 Adds a role to an existing user --------------

Add-DcsUserRole -User "Jane Doe" -Role "Full Privileges"

Adds the "Full Privileges" predefined role to the previously registered user named "Jane Doe".

Name : Jane Doe
Description : Storage Administrator
EmailAddress : jane.doe@acme.com
BlendedPrivileges : All
IsAdministrator : False
RoleIds : {{DAD4B92D-BFC8-4628-A313-51D8B2F57083}}
SequenceNumber : 5799
Id : 34383bd0-487b-4d89-8d45-7ca68ae43f30
Caption : Jane Doe
ExtendedCaption : Jane Doe
Internal : False
     

To Table of Contents

NAME

Add-DcsvCenter

SYNOPSIS

Adds a VMware vCenter configuration to the server group configuration. VMware hosts and virtual machines in the vCenter are added as hosts.

SYNTAX

Add-DcsvCenter   -Address <String>   [ -Username <String> ]   [ -Password <String> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsvCenter   -Address <String>   [ -Credential <PSCredential> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Adds a VMware vCenter configuration to the server group configuration. VMware hosts and virtual machines in the vCenter are added as hosts.

PARAMETERS

-Address<String>
Computer name or IP address of the vCenter to be added.

Required: true
Position: 1
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Username<String>
User name of the account used to connect to the vCenter.

Required: false
Position: 2
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Password<String>
Login password of the account used to connect to the vCenter.

Required: false
Position: 3
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Credential<PSCredential>
The PSCredential object containing user name and password for the vCenter. This object can be obtained by invoking the Windows PowerShell cmdlet Get-Credential, see Example 2. In this manner, credentials can be passed through the object instead of typing the credentials.

Required: false
Position: 2
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

VimVirtualCenterData : Object that identifies and describes the vCenter.

NOTES

Also see Get-DcsvCenter, Add-DcsvCenterDataStore, Set-DcsvCenterProperties, Remove-DcsvCenter, Set-DcsvCenterMultipathPolicy, Set-DcsHypervisorHost.

EXAMPLES

-------------- Example 1 Adds a vCenter using username and password --------------

Add-DcsvCenter -Address esxvc55 -Username administrator -Password vmvcenterpw

Adds the vCenter with the name "esxvc55" to the configuration. The username and password of the vCenter login are "administrator" and "vmvcenterpw".

ServerAddress : esxvc55
Username : administrator
Description :
FullName : VMware vCenter Server 5.5.0 build-1099559
ProductBuild : 1099559
Version : 5.5
State : WaitingForFirstUpdate
SequenceNumber : 23793
Id : 0A76B835-99B2-4340-97F3-3E5F769589AE
Caption : esxvc55
ExtendedCaption : esxvc55
Internal : False
     

-------------- Example 2 Adds a vCenter by passing the PSCredential object --------------

$vCtrCred = Get-Credential

Add-DcsvCenter -Address esxvc55 -Credential $vCtrCred

The Windows PowerShell cmdlet Get-Credential is invoked to collect the credentials for the vCenter. When Get-Credential is invoked a dialog box opens and the user name and password can be entered in a secure manner. The credentials are saved to the variable $vCtrCred.

cmdlet Get-Credential at command pipeline position 1
Supply values for the following parameters:
Credential
                                

To Table of Contents

NAME

Add-DcsvCenterDataStore

SYNOPSIS

Adds a VMFS datastore on a virtual disk that is served to a VMware host or virtual machine.

SYNTAX

Add-DcsvCenterDataStore   -VimClient <Object>   -VirtualDisk <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Adds a VMFS datastore on a virtual disk that is served to a VMware host or virtual machine. The datastore will span the entire virtual disk.

PARAMETERS

-VimClient<Object>
VimclientHostData object, name, or ID that identifies the ESX host or virtual machine. (The VimClientHostData object is a type of ClientHostData and can be retrieved from invoking Get-DcsClient.)

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-VirtualDisk<Object>
VirtualDiskData object, name, or ID that identifies the virtual disk.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

VirtualDiskData : Object that identifies and describes the virtual disk.

OUTPUTS

NOTES

Also see Get-DcsvCenter, Add-DcsvCenterDataStore, Set-DcsvCenterProperties, Remove-DcsvCenter, Set-DcsvCenterMultipathPolicy

EXAMPLES

-------------- Example 1 Adds a datastore to a specific virtual disk served to a VMware Host --------------

Add-DcsvCenterDataStore -VimClient (Get-DcsClient -Client audi.datacoresoftware.com) -VirtualDisk "Virtual disk 1"

The cmdlet Add-DcsvCenterDataStore is invoked and the object used for the parameter VimClient is retrieved by invoking Get-DcsClient for the VMware Host named "audi.datacoresoftware.com". The value of the parameter VirtualDisk is the name "Virtual disk 1".


To Table of Contents

NAME

Add-DcsVirtualDisk

SYNOPSIS

Creates a virtual disk.

SYNTAX

Add-DcsVirtualDisk   [ -Name <String> ]   -Size <DataSize>   [ -SectorSize <DataSize> ]   [ -Count <Int32> ]   [ -Server <String> ]   -Pool <String>   [ -AssignToCurrentUser]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsVirtualDisk   [ -Name <String> ]   -Size <DataSize>   [ -SectorSize <DataSize> ]   -LogicalDisk <Object>   [ -AssignToCurrentUser]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsVirtualDisk   [ -Name <String> ]   -Size <DataSize>   [ -SectorSize <DataSize> ]   [ -Count <Int32> ]   [ -FirstServer <String> ]   [ -SecondServer <String> ]   [ -FirstPool <String> ]   [ -SecondPool <String> ]   [ -FirstPassThroughDisk <String> ]   [ -SecondPassThroughDisk <String> ]   [ -EnableRedundancy]   [ -AssignToCurrentUser]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsVirtualDisk   [ -Name <String> ]   -Size <DataSize>   [ -SectorSize <DataSize> ]   -FirstLogicalDisk <Object>   -SecondLogicalDisk <Object>   [ -AssignToCurrentUser]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsVirtualDisk   [ -Name <String> ]   -Size <DataSize>   [ -SectorSize <DataSize> ]   [ -Count <Int32> ]   [ -FirstServer <String> ]   [ -SecondServer <String> ]   [ -SharedPool <String> ]   [ -ApproveSMPA]   [ -SharedDisk <String> ]   [ -EnableRedundancy]   [ -AssignToCurrentUser]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsVirtualDisk   [ -Name <String> ]   -PassThroughDisk <String>   [ -Server <String> ]   [ -AssignToCurrentUser]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Creates a virtual disk. Multiple virtual disks can be created if all storage sources are from pools. All virtual disks will be created using the same parameters. If using a pass-through or logical disk as a storage source, then one virtual disk can be created. Virtual disks can be single, dual, or mirrored. After virtual disks are created, virtual disks can be served to clients, see Serve-DcsVirtualDisk. Properties can be customized, see Set-DcsVirtualDiskProperties, Set-DcsVirtualDiskSize.

PARAMETERS

-Name<String>
Name of the virtual disk to create. If specified and multiple virtual disks will be created, the virtual disks created will begin with the designated name and have a number appended to the end of the name. Subsequent names will have the number incremented.If not specified a default name will be assigned. The default name will consist of "Virtual disk" with the next available number assigned. For instance, if no other virtual disks have default names assigned, the virtual disk will be named "Virtual disk 1". If creating multiple virtual disks, subsequent virtual disks created will be named "virtual disk 2" and so on.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Size<DataSize>
The size of the virtual disk to create. Valid values consist of the number followed by the unit of measurement (MB, GB, TB). Decimals may be used. For example, "100GB", "1.5TB", and "500000MB" are valid sizes. Size can range from a miniumum of 1GB to a maximum of 1024TB.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-SectorSize<DataSize>
The sector size of the virtual disk. Valid values are "512", "512B", "4096", or "4KB". If the unit is not included, it is assumed to represent the number of bytes in the sector. If this parameter is not specified, the default of 512 bytes will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Count<Int32>
The number of virtual disks to create when storage sources are from pools. If not specified, one virtual disk will be created. Multiple virtual disks will be created with the same specifications indicated in the Cmdlet parameters. Multiple virtual disks cannot be created using pass-through disks or logical disks.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Server<String>
Computer name or ID of the server used to create a single virtual disk. The computer name must be unique or the name must be fully qualified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Pool<String>
Name or ID of the disk pool to use as the storage source of a single virtual disk. To resolve by name, the name must be unique to the server group or the server must be specified. If the pool is not specified, the pool with the largest amount of available space on the specified server will be used.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-AssignToCurrentUser<SwitchParameter>
Use this parameter to assign exclusive ownership to the user account currently logged in. This restricts all operations on the virtual disks being created to only the authenticated user for the current PowerShell session.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-LogicalDisk<Object>
LogicalDiskData object or ID of the logical disk used as the storage source of a single virtual disk. The LogicalDiskData object can be retrieved by invoking Get-DcsLogicalDisk.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-FirstServer<String>
Computer name or ID of the server with the first storage source (FirstPassThroughDisk or FirstDiskPool parameters) used in a mirrored or dual virtual disk. The computer name must be unique or the name must be fully qualified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-SecondServer<String>
Computer name or ID of the server with the second storage source (SecondPassThroughDisk or SecondDiskPool parameters) used in a mirrored or dual virtual disk. The computer name must be unique or the name must be fully qualified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-FirstPool<String>
Name or ID of the disk pool to use as the first storage source of a mirrored virtual disk. To resolve by name, the name must be unique to the server group or the server must be specified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-SecondPool<String>
Name or ID of the disk pool to use as the second storage source of a mirrored virtual disk. To resolve by name, the name must be unique to the server group or the server must be specified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-FirstPassThroughDisk<String>
The disk name or ID of the pass-through disk used as the first storage source of a mirrored virtual disk. To resolve by name, the name must be unique to the server group or the server must be specified. Data on the specified first pass-through disk will be mirrored to the second storage source (SecondDiskPool or SecondPassThroughDisk parameters).

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-SecondPassThroughDisk<String>
The disk name or ID of the pass-through disk used as the second storage source of a mirrored virtual disk. To resolve by name, the name must be unique to the server group or the server must be specified. IMPORTANT: The data on the specified second pass-through disk will be overwritten and replaced with the data from the first storage source (FirstDiskPool or FirstPassThroughDisk parameters).

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-EnableRedundancy<SwitchParameter>
Specify this parameter to create redundant mirror paths between servers. Redundant mirror paths provide two mirror paths going in each direction between servers. Redundant paths can be either iSCSI or Fibre Channel. Each server is required to have two FC or two iSCSI ports with the mirror role enabled (see Set-DcsServerPortProperties). Port paths are automatically selected.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-FirstLogicalDisk<Object>
LogicalDiskData object or ID of the logical disk used as the first storage source of a mirrored or dual virtual disk. Data on the specified first logical disk will be mirrored to the second logical disk. The LogicalDiskData object can be retrieved by invoking Get-DcsLogicalDisk.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-SecondLogicalDisk<Object>
LogicalDiskData object or ID of the logical disk used as the second storage source of a mirrored or dual virtual disk. IMPORTANT: The data on the specified second logical disk will be overwritten and replaced with the data from the first logical disk. The LogicalDiskData object can be retrieved by invoking Get-DcsLogicalDisk.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-SharedPool<String>
Name or ID that identifies a shared disk pool to use when creating a dual virtual disk. To resolve by name, the name must be unique to the server group or the server must be specified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-ApproveSMPA<SwitchParameter>
Specify this parameter to acknowledge that all disks in the shared pool are qualified shared multi-port array disks. The shared pool must be SMPA approved in order to create dual virtual disks.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-SharedDisk<String>
Name or ID that identifies a shared physical disk. To resolve by name, the name must be unique to the server group or the server must be specified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PassThroughDisk<String>
The disk name or ID of the pass-through disk used as the storage source of a non-mirrored virtual disk. To resolve by name, the name must be unique to the server group or the server must be specified.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

LogicalDiskData : Object the identifies and describes the logical disk.

OUTPUTS

VirtualDiskData : Object that identifies and describes the virtual disk. One object is returned for each virtual disk created.

NOTES

Also see Get-DcsLogicalDisk, Add-DcsLogicalDisk, Get-DcsVirtualDisk, Set-DcsVirtualDiskProperties, Set-DcsVirtualDiskSize, Serve-DcsVirtualDisk, Enable-DcsDataProtection, Enable-DcsSequentialStorage, Add-DcsSnapshot, Add-DcsReplication, Unlock-DcsPhysicalDisk.

EXAMPLES

-------------- Example 1 Creates a single virtual disk --------------

Add-DcsVirtualDisk -Name VDisk1 -Size 100GB -Server SSV1 -Pool SSV1Pool3

Creates a single virtual disk named "VDisk1" with a size of 100 GB. The source is from the pool named "SSV1Pool3" on the server named "SSV1". The sector size was not specified so the default of 512 bytes will be used.

VirtualDiskGroupId :
FirstHostId : 74EDD1B3-6682-46A7-943C-2F0168CEC699
SecondHostId :
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
SnapshotPoolId :
Alias : VDisk1
Description :
Size : 100.00 GB
SectorSize : 512 B
Type : NonMirrored
DiskStatus : Failed
InquiryData : DataCore Virtual Disk DCS
ScsiDeviceId : {96, 3, 13, 144...}
ScsiDeviceIdString : 60030D90BACB6807A841CFAA0E0AE367
RemovableMedia : False
WriteThrough : False
Offline : False
Disabled : False
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : False
Id : 39ddeb4ad1c94197bd805c58a113a112
Caption : VDisk1
ExtendedCaption : VDisk1 from LOCAL
Internal : False
     

-------------- Example 2 Creates a mirrored virtual disk --------------

Add-DcsVirtualDisk -Name VDisk2 -Size "500 GB" -SectorSize 4096 FirstServer SSV1 -SecondServer SSV2 -FirstPool SSV1Pool1 -SecondPool SSV2Pool3

Creates a 500 GB mirrored virtual disk named "Vdisk2". The first storage source is the pool named "SSV1Pool1" on the server named "SSV1", and the second storage source is the pool named "SSV2Pool3" on the server named "SSV2". The sector size is 4096 bytes (4 KB).

VirtualDiskGroupId :
FirstHostId : 74EDD1B3-6682-46A7-943C-2F0168CEC699
SecondHostId : FD622C7A-1065-4F2B-97E5-11813DA5AAF5
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
SnapshotPoolId :
Alias : VDisk2
Description :
Size : 500.00 GB
SectorSize : 4 KB
Type : MultiPathMirrored
DiskStatus : Failed
InquiryData : DataCore Virtual Disk DCS
ScsiDeviceId : {96, 3, 13, 144...}
ScsiDeviceIdString : 60030D90BACB6807A841CFAA0E0AE367
RemovableMedia : False
WriteThrough : False
Offline : False
Disabled : False
ManualRecovery : False
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : False
Id : ba12f1d9e84b44708d7eab01f3572b5d
Caption : VDisk2
ExtendedCaption : VDisk2 from LOCAL
Internal : False
     

-------------- Example 3 Creates a mirrored virtual disk using two logical disks --------------

Add-DcsVirtualDisk -Name "VD99FTL" -FirstLogicalDisk (Add-DcsLogicalDisk -Server SSV1 -Pool "Disk pool 1") -SecondLogicalDisk (Add-DcsLogicalDisk -Server SSV2 -Pool "Disk pool 2")

Creates a 1 PB (default size) mirrored virtual disk named "VD99FTL". In this case, the first and second logical disks were both created by invoking the Add-DcsLogicalDisk cmdlet within the Add-DcsVirtualDisk operation (although existing logical disks could also be used).

VirtualDiskGroupId :
FirstHostId : F5381494-7319-4F56-8890-01705D0F5227
SecondHostId : AA4A7D96-81A9-4BB2-AFD6-B96B29599ECE
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
SnapshotPoolId :
Alias : VD99FTL
Description :
Size : 1.00 PB
SectorSize : 512 B
Type : MultiPathMirrored
DiskStatus : Failed
InquiryData : DataCore Virtual Disk DCS
ScsiDeviceId : {96, 3, 13, 144...}
ScsiDeviceIdString : 60030D90BACB6807A841CFAA0E0AE367
RemovableMedia : False
WriteThrough : False
Offline : False
Disabled : False
ManualRecovery : False
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Low
IsServed : False
Id : f7dd03cbf4164a248b4637e1d1f6d823
Caption : VD99FTL
ExtendedCaption : VD99FTL from Server Group LOCAL
Internal : False
     

-------------- Example 4 Creates a dual virtual disk from a shared passthrough disk. --------------

$sharedpassthru = Get-DcsSharedPhysicalDisk -Server SSV1 -PhysicalDisk "SSV1-WDC50-D1"

Add-DcsVirtualDisk -Size 50GB -FirstServer SSV1 -SecondServer SSV2 -SharedDisk $sharedpassthru

The cmdlet Get-DcsSharedPhysicalDisk is invoked to return the SharedPhysicalDiskData object for the shared physical disk named "SSV1-WDC50-D1" on the server named "SSV1". The object is stored in the variable "$sharedpassthru". The cmdlet Add-DcsVirtualDisk is invoked to create a 50GB dual virtual disk on servers named "SSV1" and "SSV2" by passing the variable "$sharedpassthru" to the parameter SharedDisk. The virtual disk is assigned a default name because the Name parameter is not specified.

VirtualDiskGroupId :
FirstHostId : 8BD7BD0F-F5F9-40DB-B8B0-6ABB74D43F81
SecondHostId : 8CE05A9F-D367-4BDE-BCE6-67909F6F7F6A
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
SnapshotPoolId :
Alias : Virtual disk 2
Description :
Size : 50.00 GB
SectorSize : 512 B
Type : Dual
DiskStatus : Failed
InquiryData : DataCore Virtual Disk DCS
ScsiDeviceId : {96, 3, 13, 144...}
ScsiDeviceIdString : 60030D90C43B6201DEFA3B4D046FD665
RemovableMedia : False
WriteThrough : False
Offline : False
Disabled : False
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : False
SequenceNumber : 61725
Id : c403478e65a24e01b389100a375a5346
Caption : Virtual disk 2
ExtendedCaption : Virtual disk 2 from Group LOCAL
Internal : False
     

-------------- Example 5 Creates a dual virtual disk from a shared logical disk --------------

$ldiskSSVVM5 = Get-DcsLogicalDisk -Server SSVVM5 | where {$_.Virtualized -eq $False}

$ldiskSSVVM6 = Get-DcsLogicalDisk -Server SSVVM6 | where {$_.MappingName -eq $ldiskSSVVM5.MappingName}

Add-DcsVirtualDisk -FirstLogicalDisk $ldiskSSVVM5.Id -SecondLogicalDisk $ldiskSSVVM6.Id -Size 50GB

The cmdlet Get-DcsLogicalDisk is invoked to get a logical disk which is not virtualized from the server SSVVM5. The object is stored in the variable $ldiskSSVVM5. Next, the cmdlet Get-DcsLogicalDisk is invoked again to get the same logical disk on server SSVVM6. In order to ensure it is the same logical disk on both servers, the MappingName must be the same. The object is stored in the variable $ldiskSSVVM6. Lastly, the cmdlet Add-DcsVirtualDisk is invoked with the FirstLogicalDisk being the Id stored in variable $ldiskSSVVM5 and the SecondLogicalDisk being the Id stored in variable $ldiskSSVVM6. The dual virtual disk is created with a size of 50GB and the VirtualDiskData object is returned.

VirtualDiskGroupId :
FirstHostId : 5583AA5D-EF6B-4A3C-8442-9E079EEE7D99
SecondHostId : 68BEE1CB-0751-4D88-B1C6-3853FDEAA800
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
SnapshotPoolId :
Alias : Virtual disk 1
Description :
Size : 50.00 GB
SectorSize : 512 B
Type : Dual
DiskStatus : Failed
InquiryData : DataCore Virtual Disk DCS
ScsiDeviceId : {96, 3, 13, 144...}
ScsiDeviceIdString : 60030D90929BEA01FEBB51CFF8941E98
RemovableMedia : False
WriteThrough : False
Offline : False
Disabled : False
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : False
SequenceNumber : 10825
Id : da19f10e1ab94110893ef1e6dd5965a7
Caption : Virtual disk 1
ExtendedCaption : Virtual disk 1 from Group2
Internal : False
     

-------------- Example 6 Creates a dual virtual disk from a shared disk pool --------------

Add-DcsVirtualDisk -Size 40GB -FirstServer SSVVM5 -SecondServer SSVVM6 -SharedPool "Shared disk pool 1" -ApproveSMPA

The cmdlet Add-DcsVirtualDisk is invoked with the first server being SSVVM5 and the second server being SSVVM6. The shared pool "Shared disk pool 1" is specified as the storage source. The shared pool is acknowledged to be SMPA approved. A dual virtual disk with a size of 40GB is created and the VirtualDiskData object is returned.

VirtualDiskGroupId :
FirstHostId : 5583AA5D-EF6B-4A3C-8442-9E079EEE7D99
SecondHostId : 68BEE1CB-0751-4D88-B1C6-3853FDEAA800
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
SnapshotPoolId :
Alias : Virtual disk 2
Description :
Size : 40.00 GB
SectorSize : 512 B
Type : Dual
DiskStatus : Failed
InquiryData : DataCore Virtual Disk DCS
ScsiDeviceId : {96, 3, 13, 144...}
ScsiDeviceIdString : 60030D90C06405024F56BD5EB96751EA
RemovableMedia : False
WriteThrough : False
Offline : False
Disabled : False
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : False
SequenceNumber : 11195
Id : 99a72f0b7f5b4295afdbf61d65bf5cb9
Caption : Virtual disk 2
ExtendedCaption : Virtual disk 2 from Group2
Internal : False
     

To Table of Contents

NAME

Add-DcsVirtualDiskFromTemplate

SYNOPSIS

Creates a virtual disk from a virtual disk template.

SYNTAX

Add-DcsVirtualDiskFromTemplate   -VirtualDiskTemplate <Object>   [ -Name <String> ]   [ -Description <String> ]   [ -Size <DataSize> ]   [ -SectorSize <DataSize> ]   [ -Count <UInt32> ]   [ -AssignToCurrentUser]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Creates a virtual disk from a virtual disk template. Some parameters are provided which can override settings in the specified template. (See Add-DcsVirtualDiskTemplate to create a template. )

PARAMETERS

-VirtualDiskTemplate<Object>
VirtualDiskTemplateData object, ID, or name that describes the template to use when creating the virtual disks.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Name<String>
Name of the virtual disk to create. If specified and multiple virtual disks will be created, the names will have a number appended to the end to make them unique. The number will begin with the first available number and will be incremented by one, provided that the name is available. Numbers will be skipped if they already exist. For instance, if the alias is "VVOLMR" and these names are available, virtual disks will be named "VVOLMR 1", "VVOLMR 2" and so on.If this parameter is not specified, the virtual disk alias, supplied when the template was created, will be used as the root of the name.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Description<String>
Description of the new virtual disks.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Size<DataSize>
The size of the virtual disk to create. If specified, this parameter will override the virtual disk size set in the template. Valid values consist of the number followed by the unit of measurement (MB, GB, TB). Decimals may be used. For example, "100GB", "1.5TB", and "500000MB" are valid sizes. Size can range from a miniumum of 1GB to a maximum of 1024TB.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-SectorSize<DataSize>
The sector size of the virtual disk. If specified, this parameter will override the sector size set in the template. Valid values are "512", "512B", "4096", or "4KB". Values "512" and "4096" are the number of bytes.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Count<UInt32>
The number of virtual disks to create. If not specified, one virtual disk will be created.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-AssignToCurrentUser<SwitchParameter>
Use this parameter to assign exclusive ownership to the user account currently logged in. This restricts all operations on the virtual disks being created to only the authenticated user for the current PowerShell session.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

VirtualDiskData : Object that identifies and describes the virtual disk. One object is returned for each virtual disk created.

NOTES

Also see Add-DcsVirtualDiskFromVirtualDisk, which creates a virtual disk using the properties of another virtual disk.

EXAMPLES

-------------- Example 1 Creates two virtual disks from a specified template. --------------

Add-DcsVirtualDiskFromTemplate -VirtualDiskTemplate "MR_100" -SectorSize 4KB -AssignToCurrentUser Count 2

The cmdlet is invoked to create two virtual disks from the template named "MR_100 with the specified sector size of 4KB and assign both virtual disks to the logged in user performing the operation. The parameter SectorSize was included to override the setting in the template.

VirtualDiskGroupId :
FirstHostId : AF7412B4-5320-4FEC-98E4-E90ED9C9BF6B
SecondHostId : 692CED43-5AE3-4CEA-87E7-7D9B4E77F180
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
SnapshotPoolId :
Alias : MR_100_
Description : Creates mirrored virtual disk 100 GB
Size : 100 GB
SectorSize : 4 KB
Type : MultiPathMirrored
DiskStatus : Offline
InquiryData : DataCore Virtual Disk DCS f4d633ec8c754689a135ac9ad1327211
ScsiDeviceId : {96, 3, 13, 144...}
ScsiDeviceIdString : 60030D9067323B07586CCE3DC06BED8E
RemovableMedia : False
WriteThrough : False
Offline : False
Disabled : False
ManualRecovery : False
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
TPThresholdsEnabled : False
IsServed : False
SubType : Standard
MirrorTrunkMappingEnabled : True
SequenceNumber : 640889
Id : f4d633ec8c754689a135ac9ad1327211
Caption : MR_100_
ExtendedCaption : MR_100_ from Server Group 1
Internal : False
     
VirtualDiskGroupId :
FirstHostId : AF7412B4-5320-4FEC-98E4-E90ED9C9BF6B
SecondHostId : 692CED43-5AE3-4CEA-87E7-7D9B4E77F180
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
SnapshotPoolId :
Alias : MR_100_1
Description : Creates mirrored virtual disk 100 GB
Size : 100 GB
SectorSize : 4 KB
Type : MultiPathMirrored
DiskStatus : Offline
InquiryData : DataCore Virtual Disk DCS 9df40c31b39e4a65bbadc86725b25ee6
ScsiDeviceId : {96, 3, 13, 144...}
ScsiDeviceIdString : 60030D9032333B078DF1AC38A4E7119E
RemovableMedia : False
WriteThrough : False
Offline : False
Disabled : False
ManualRecovery : False
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
TPThresholdsEnabled : False
IsServed : False
SubType : Standard
MirrorTrunkMappingEnabled : True
SequenceNumber : 640890
Id : 9df40c31b39e4a65bbadc86725b25ee6
Caption : MR_100_1
ExtendedCaption : MR_100_1 from Server Group 1
Internal : False
     

To Table of Contents

NAME

Add-DcsVirtualDiskFromVirtualDisk

SYNOPSIS

Creates a new virtual disk with the same properties and settings as an existing virtual disk.

SYNTAX

Add-DcsVirtualDiskFromVirtualDisk   -VirtualDisk <Object>   [ -Name <String> ]   [ -Description <String> ]   [ -Count <Int32> ]   [ -AutoCreate]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsVirtualDiskFromVirtualDisk   -VirtualDisk <Object>   [ -Name <String> ]   [ -Description <String> ]   [ -Count <Int32> ]   [ -CopyMappings]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Creates a new virtual disk with the same properties and settings as an existing virtual disk. The existing virtual disk will be used as a "model" to create the new virtual disk. The new virtual disk will be created from the same storage sources. If optional parameters are not included, one virtual disk will be created with a default name and mirror paths will be auto-selected by the software.

PARAMETERS

-VirtualDisk<Object>
VirtualDiskData object, name, or ID that identifies the virtual disk to use as a model.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Name<String>
Name of the virtual disk to create. If specified and multiple virtual disks will be created, the virtual disks created will begin with the designated name and have a number appended to the end of the name. Subsequent names will have the number incremented.If not specified a default name will be assigned. The default name will consist of "Virtual disk" with the next available number assigned. For instance, if no other virtual disks have default names assigned, the virtual disk will be named "Virtual disk 1". If creating multiple virtual disks, subsequent virtual disks created will be named "virtual disk 2" and so on.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Description<String>
Description of the new virtual disk.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Count<Int32>
The number of virtual disks to create when storage sources are from pools. If not specified, one virtual disk will be created.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-AutoCreate<SwitchParameter>
Use this parameter to allow the software to auto-select mirror paths. Auto-selection of mirror paths is also the default behavior if neither AutoCreate or CopyMappings parameters are included in the command.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-CopyMappings<SwitchParameter>
Use this parameter to specify that mirror paths should be identical to the virtual disk that is used as a model.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

VirtualDiskData : Object that identifies and describes the virtual disk.

OUTPUTS

VirtualDiskData : Object that identifies and describes the virtual disk. One object is returned for each virtual disk created.

NOTES

Also see Get-DcsVirtualDisk.

EXAMPLES

-------------- Example 1 Creates one virtual disk with only the existing virtual disk specified. --------------

Add-DcsVirtualDiskFromVirtualDisk -VirtualDisk "Virtual disk 1"

The existing virtual disk named "Virtual disk 1" is used as a model to create a new virtual disk with the same properties and settings as "Virtual disk 1". No optional parameters are supplied in the command, so one virtual disk is created with a default name and mirror paths are auto-selected.

VVirtualDiskGroupId :
FirstHostId : 09440587-2E02-4BAA-8CC5-162B1DF66BE8
SecondHostId : 60858B8A-928F-4CF0-9FBA-A62DC4C120C7
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
SnapshotPoolId :
Alias : Virtual disk 5
Description :
Size : 5 GB
SectorSize : 512 B
Type : MultiPathMirrored
DiskStatus : Failed
InquiryData : DataCore Virtual Disk DCS c093a0025cbf4ee28d0a64a131136618
ScsiDeviceId : {96, 3, 13, 144...}
ScsiDeviceIdString : 60030D90B64BE60659BEAF27834D369C
RemovableMedia : False
WriteThrough : False
Offline : False
Disabled : False
ManualRecovery : False
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : False
SubType : Standard
MirrorTrunkMappingEnabled : False
SequenceNumber : 5358
Id : c093a0025cbf4ee28d0a64a131136618
Caption : Virtual disk 5
ExtendedCaption : Virtual disk 5 from LocalGroup1
Internal : False
     

-------------- Example 2 Creates multiple virtual disks with identical mirror paths --------------

Add-DcsVirtualDiskFromVirtualDisk -VirtualDisk "Virtual disk 1" -Name "BillingQ3" -Description "Account Billing for Q3" -Count 2 -CopyMappings

The existing "Virtual disk 1" is used as a model to create 3 new virtual disks. The new virtual disks will have the same properties and settings as "Virtual disk 1". The names for the new virtual disks will have a root of "BillingQ3". The description for those virtual disks will be "Account Billing for Q3". The parameter CopyMappings is included in the command to specify that the mirror paths should be identical to the paths used for "Virtual disk 1".

VirtualDiskGroupId :
FirstHostId : 09440587-2E02-4BAA-8CC5-162B1DF66BE8
SecondHostId : 60858B8A-928F-4CF0-9FBA-A62DC4C120C7
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
SnapshotPoolId :
Alias : BillingQ3
Description : Account Billing for Q3
Size : 5 GB
SectorSize : 512 B
Type : MultiPathMirrored
DiskStatus : Failed
InquiryData : DataCore Virtual Disk DCS 02da20543e2b45e7ac9eb228c4adc404
ScsiDeviceId : {96, 3, 13, 144...}
ScsiDeviceIdString : 60030D90E3542C07DABD4C1BC61174B4
RemovableMedia : False
WriteThrough : False
Offline : False
Disabled : False
ManualRecovery : False
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : False
SubType : Standard
MirrorTrunkMappingEnabled : False
SequenceNumber : 6121
Id : 02da20543e2b45e7ac9eb228c4adc404
Caption : BillingQ3
ExtendedCaption : BillingQ3 from LocalGroup1
Internal : False
     
VirtualDiskGroupId :
FirstHostId : 09440587-2E02-4BAA-8CC5-162B1DF66BE8
SecondHostId : 60858B8A-928F-4CF0-9FBA-A62DC4C120C7
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
SnapshotPoolId :
Alias : BillingQ 4
Description : Account Billing for Q3
Size : 5 GB
SectorSize : 512 B
Type : MultiPathMirrored
DiskStatus : Failed
InquiryData : DataCore Virtual Disk DCS e4b624874b5d4b42921866ac22bb5c7c
ScsiDeviceId : {96, 3, 13, 144...}
ScsiDeviceIdString : 60030D9065572C0760BD8AECC71CFC58
RemovableMedia : False
WriteThrough : False
Offline : False
Disabled : False
ManualRecovery : False
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : False
SubType : Standard
MirrorTrunkMappingEnabled : False
SequenceNumber : 6216
Id : e4b624874b5d4b42921866ac22bb5c7c
Caption : BillingQ 4
ExtendedCaption : BillingQ 4 from LocalGroup1
Internal : False
     

To Table of Contents

NAME

Add-DcsVirtualDiskGroup

SYNOPSIS

Creates a virtual disk group.

SYNTAX

Add-DcsVirtualDiskGroup   -Name <String>   [ -Description <String> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Creates a virtual disk group.

PARAMETERS

-Name<String>
Name of the virtual disk group.

Required: true
Position: 1
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Description<String>
Description of the virtual disk group.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

string : The name of the virtual disk group.

OUTPUTS

VirtualDiskGroupData : Object that identifies and describes the virtual disk group.

NOTES

Also see Get-DcsVirtualDiskGroup, Add-DcsVirtualDiskToGroup, Remove-DcsVirtualDiskfromGroup, Remove-DcsVirtualDiskGroup, Set-DcsVirtualDiskGroupProperties.

EXAMPLES

-------------- Example 1 Creates a virtual disk group. --------------

Add-DcsVirtualDiskGroup -Name "VD Group FTL" -Description "Mail server backup for Ft. Lauderdale" -Connection SSVVM1Connect

Creates a group named "VD Group FTL" with a description of "Mail server backup for Ft. Lauderdale" for the server group of the connection named "SSVVM1Connect".

Alias : VD Group FTL
Description : Mail server backup for Ft. Lauderdale
Id : {ef015296-0fa8-4bec-80a9-e312547c94a9}
Caption : VD Group FTL
ExtendedCaption :
Internal : False
     

To Table of Contents

NAME

Add-DcsVirtualDiskMirror

SYNOPSIS

Adds a mirror to a virtual disk.

SYNTAX

Add-DcsVirtualDiskMirror   [ -Server <String> ]   -VirtualDisk <Object>   -Pool <String>   [ -EnableRedundancy]   [ -SourceLogicalDisk <String> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsVirtualDiskMirror   [ -Server <String> ]   -VirtualDisk <Object>   [ -PassThroughDisk <String> ]   [ -EnableRedundancy]   [ -SourceLogicalDisk <String> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsVirtualDiskMirror   -VirtualDisk <Object>   [ -EnableRedundancy]   -LogicalDisk <String>   [ -SourceLogicalDisk <String> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Adds a mirror to a virtual disk. The storage source of the mirror to add can be a pool, pass-through disk, or an existing logical disk. A mirror may be added to a single or mirrored virtual disk.

PARAMETERS

-Server<String>
Computer name or ID of the server that will be adding a mirror to the virtual disk. The computer name must be unique or the name must be fully qualified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-VirtualDisk<Object>
VirtualDiskData object, name, or ID that identifies the single virtual disk.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Pool<String>
Name or ID of the disk pool to use as the storage source of the mirror. To resolve by name, the name must be unique to the server group or the server must be specified.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-EnableRedundancy<SwitchParameter>
Specify this parameter to create redundant mirror paths between servers. Redundant mirror paths provide two mirror paths going in each direction between servers. Redundant paths can be either iSCSI or Fibre Channel. Each server is required to have two FC or two iSCSI ports with the mirror role enabled (see Set-DcsServerPortProperties). Port paths are automatically selected.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-SourceLogicalDisk<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PassThroughDisk<String>
The disk name or ID of the pass-through disk used as the storage source of the mirror. To resolve by name, the name must be unique to the server group or the server must be specified. Note: The data on the virtual disk will be copied to the pass-through disk.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-LogicalDisk<String>
ID or caption of the logical disk used as the storage source of a single virtual disk. Information for the logical disk can be retrieved by invoking Get-DcsLogicalDisk.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

VirtualDiskData : Object that identifies and describes the virtual disk.

OUTPUTS

VirtualDiskData : Object that identifies and describes the virtual disk.

NOTES

Also see Split-DcsVirtualDisk, Set-DcsVirtualDiskProperties, Unlock-DcsPhysicalDisk.

EXAMPLES

-------------- Example 1 Adds a mirror to a single virtual disk --------------

Add-DcsVirtualDiskMirror -Server SSV2 -VirtualDisk VDisk1 -Pool SSV2Pool3 -EnableRedundancy -Connection SSV1Connect

Adds a mirror to the existing single virtual disk named "VDisk1". The mirror will be created from the pool named "SSV2Pool3" on the server named "SSV2". The connection to use is SSV1Connect.

VirtualDiskGroupId :
FirstHostId : 74EDD1B3-6682-46A7-943C-2F0168CEC699
SecondHostId : FD622C7A-1065-4F2B-97E5-11813DA5AAF5
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
Alias : VDisk1
Description :
Size : 100.00 GB
Type : MultiPathMirrored
DiskStatus : FailedRedundancy
InquiryData : DataCore Virtual Disk DCS
ScsiDeviceId : {96, 3, 13, 144...}
RemovableMedia : False
WriteThrough : False
Offline : False
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : False
Id : 39ddeb4ad1c94197bd805c58a113a112
Caption : VDisk1
ExtendedCaption : VDisk1 from LOCAL
Internal : False
     

To Table of Contents

NAME

Add-DcsVirtualDiskTemplate

SYNOPSIS

Creates a template that can be used to create virtual disks.

SYNTAX

Add-DcsVirtualDiskTemplate   -Name <String>   -FirstPool <String>   [ -FirstServer <String> ]   [ -SecondPool <String> ]   [ -SecondServer <String> ]   -VirtualDiskSize <DataSize>   [ -VirtualDiskSectorSize <DataSize> ]   -VirtualDiskAlias <String>   [ -SnapshotServer <String> ]   [ -SnapshotPool <String> ]   [ -ContinuousDataProtectionServer <String> ]   [ -ContinuousDataProtectionPool <String> ]   [ -ContinuousDataProtectionLogSize <DataSize> ]   [ -StorageProfile <String> ]   [ -UseRedundantMirrorMappings <Boolean> ]   [ -AllocationAttentionThreshold <UInt64> ]   [ -AllocationWarningThreshold <UInt64> ]   [ -AllocationCriticalThreshold <UInt64> ]   [ -LatencyAttentionThreshold <UInt64> ]   [ -LatencyWarningThreshold <UInt64> ]   [ -LatencyCriticalThreshold <UInt64> ]   [ -StorageLatencyAttentionThreshold <UInt64> ]   [ -StorageLatencyWarningThreshold <UInt64> ]   [ -StorageLatencyCriticalThreshold <UInt64> ]   [ -ReservedSpacePercentage <UInt32> ]   [ -WriteThroughEnabled]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Add-DcsVirtualDiskTemplate   -Name <String>   -FirstPool <String>   [ -FirstServer <String> ]   [ -SecondPool <String> ]   [ -SecondServer <String> ]   -VirtualDiskSize <DataSize>   [ -VirtualDiskSectorSize <DataSize> ]   -VirtualDiskAlias <String>   [ -SnapshotServer <String> ]   [ -SnapshotPool <String> ]   [ -StorageProfile <String> ]   [ -UseSequentialStorage]   [ -UseRedundantMirrorMappings <Boolean> ]   [ -AllocationAttentionThreshold <UInt64> ]   [ -AllocationWarningThreshold <UInt64> ]   [ -AllocationCriticalThreshold <UInt64> ]   [ -LatencyAttentionThreshold <UInt64> ]   [ -LatencyWarningThreshold <UInt64> ]   [ -LatencyCriticalThreshold <UInt64> ]   [ -StorageLatencyAttentionThreshold <UInt64> ]   [ -StorageLatencyWarningThreshold <UInt64> ]   [ -StorageLatencyCriticalThreshold <UInt64> ]   [ -ReservedSpacePercentage <UInt32> ]   [ -WriteThroughEnabled]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Creates a template that can be used to create virtual disks. Parameters are included to set the properties and settings for the template. Virtual disks created from the template will have the same properties and settings of the template and can be used to create different virtual disk subtypes (standard, VVOLs, or protocol endpoints). To create virtual disks from a template, see Add-DcsVirtualDiskFromTemplate.

PARAMETERS

-Name<String>
Name of the virtual disk template being created.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-FirstPool<String>
Name or ID of the disk pool to use as the first storage source of the virtual disks created from the template. To resolve by name, the name must be unique to the server group or the server must be specified.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-FirstServer<String>
Computer name or ID of the server supplying the first storage source (FirstPool parameter). The computer name must be unique or the name must be fully qualified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-SecondPool<String>
Name or ID of the disk pool to use as the second storage source of virtual disks created from this template when mirrored virtual disks will be created. To resolve by name, the name must be unique to the server group or the server must be specified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-SecondServer<String>
Computer name or ID of the server supplying the second storage source (SecondPool parameter). The computer name must be unique or the name must be fully qualified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-VirtualDiskSize<DataSize>
The size of the virtual disk to create from the template. Valid values consist of the number followed by the unit of measurement (MB, GB, TB). Decimals may be used. For example, "100GB", "1.5TB", and "500000MB" are valid sizes. Size can range from a miniumum of 1GB to a maximum of 1024TB.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-VirtualDiskSectorSize<DataSize>
The sector size of the virtual disk to create from the template. Valid values are "512", "512B", "4096", or "4KB". If the unit is not included, it is assumed to represent the number of bytes in the sector. If this parameter is not specified, the default of 512 bytes will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-VirtualDiskAlias<String>
Name of the virtual disk to create from the template. If multiple virtual disks will be created, the names will beginning with the root name and subsequent virtual disks will have a number appended to the end to make them unique. The number will begin with the first available number and will be incremented by one provided that the name is available. Numbers will be skipped if they already exist. For instance, if the alias is "VVOLMR" and these names are available, virtual disks will be named "VVOLMR", "VVOLMR 1", "VVOLMR 2" and so on.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-SnapshotServer<String>
Computer name or ID of the server with the preferred snapshot pool (SnapshotPool parameter). The computer name must be unique or the name must be fully qualified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-SnapshotPool<String>
Name or ID that identifies the preferred snapshot pool. Snapshots of virtual disks created from this template will be created from this pool. To resolve by name, the name must be unique to the server group or the server (SnapshotServer parameter) must be specified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-ContinuousDataProtectionServer<String>
Computer name or ID of the server with the pool (ContinousDataProtectionPool parameter) used for the history log. The computer name must be unique or the name must be fully qualified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-ContinuousDataProtectionPool<String>
Name or ID of the disk pool to use as the source of the history log. To resolve by name, the name must be unique to the server group or the server must be specified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-ContinuousDataProtectionLogSize<DataSize>
The maximum size of the history log for data protection. Valid values consist of the number followed by the unit of measurement (MB, GB, TB). Decimals may be used. For example, "10GB", "20.5GB", and "5000MB" are valid sizes. The history log size can range from a minimum of 8GB up to 1024TB. If not specified, the default history log size will be 5% of the size of the CDP-enabled virtual disk or 8GB, whichever is larger.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-StorageProfile<String>
Use this parameter to set the storage profile. Valid values in order from highest priority to lowest priority are: "Critical", "High", "Normal", "Low", and "Archive". A custom storage profile can also be set. If this parameter is not set, the default setting of "Normal" will be used in the template.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-UseRedundantMirrorMappings<Boolean>
Use this parameter to enable or disable the redundant mirror paths property for this template. Specify $true to create redundant mirror paths for virtual disks created from this template or $false to disable the redundant mirror paths property. Redundant mirror paths provide two mirror paths going in each direction between servers. Redundant paths can be either iSCSI or Fibre Channel. Each server is required to have two FC or two iSCSI ports with the mirror role enabled (see Set-DcsServerPortProperties). Port paths are automatically selected.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-AllocationAttentionThreshold<UInt64>
This parameter will set the attention level of the Allocated Space Threshold in System Health. The value is the percentage of allocated space in the virtual disk. Valid values are "0" - "101". For example, if the threshold is set to "80", an attention level message will be generated when the virtual disk reaches 80% allocated. The value "101" will silence the message so that it will not be generated. If this parameter is not set, the default value of "100" will be used in the template.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-AllocationWarningThreshold<UInt64>
This parameter will set the warning level of the Allocated Space Threshold in System Health. The value is the percentage of allocated space in the virtual disk. Valid values are "0" - "101". For example, if the threshold is set to "90", a warning level message will be generated when the virtual disk reaches 90% allocated. If this parameter is not set, the default value of "101" will be used in the template. The default value will silence the message so that it will not be generated.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-AllocationCriticalThreshold<UInt64>
This parameter will set the critical level for the Allocated Space Threshold in System Health. The value is the percentage of allocated space in the virtual disk. Valid values are "0" - "100". For example, if the threshold is set to "100", a critical level message will be generated when the virtual disk reaches 100% allocated. If this parameter is not set, the default value of "101" will be used in the template. The default value will silence the message so that it will not be generated.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-LatencyAttentionThreshold<UInt64>
This parameter sets the attention level of the I/O Latency Threshold in System Health. The value is the amount of milliseconds (ms). Valid values are "0" through "60000". The default value is "5000". In this case, when the latency for a front-end path to the virtual disk reaches 5,000 ms, an attention level message will be generated. If this parameter is not set, the default value will be used in the template.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-LatencyWarningThreshold<UInt64>
This parameter sets the warning level of the I/O Latency Threshold in System Health. The value is the amount of milliseconds (ms). Valid values are "0" to "60000". The default value is "10000". In this case, when the latency for a front-end path to the virtual disk reaches 10,000 ms, a warning level message will be generated. If this parameter is not set, the default value will be used in the template.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-LatencyCriticalThreshold<UInt64>
This parameter sets the critical level of the I/O Latency Threshold in System Health. The value is the amount of milliseconds (ms). Valid values are "0" to "60000". The default value is "30000". In this case, when the latency for a front-end path to the virtual disk reaches 30,000 ms, a critical level message will be generated. If this parameter is not set, the default value will be used in the template.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-StorageLatencyAttentionThreshold<UInt64>
This parameter sets the attention level of the Storage Latency Threshold in System Health. The value is the amount of milliseconds (ms). Valid values are "0" through "60000". The default value is "5000". In this case, when the latency for a back-end path to the disk reaches 5,000 ms, an attention level message will be generated. If this parameter is not set, the default value will be used in the template.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-StorageLatencyWarningThreshold<UInt64>
This parameter sets the warning level of the Storage Latency Threshold in System Health. The value is the amount of milliseconds (ms). Valid values are "0" to "60000". The default value is "10000". In this case, when the latency for a back-end path to the disk reaches 10,000 ms, a warning level message will be generated. If this parameter is not set, the default value will be used in the template.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-StorageLatencyCriticalThreshold<UInt64>
This parameter sets the critical level of the Storage Latency Threshold in System Health. The value is the amount of milliseconds (ms). Valid values are "0" to "60000". The default value is "30000". In this case, when the latency for a back-end path to the disk reaches 30,000 ms, a critical level message will be generated. If this parameter is not set, the default value will be used in the template.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-ReservedSpacePercentage<UInt32>
Use this parameter to reserve a percentage of space in each pool for exclusive use by virtual disks created from the template. A valid value is a number between 0 and 100 which refers to the percentage. For example, to reserve 50% space, enter the value "50". If this parameter is not specified, the default of "0" will be used, which will not reserve any space.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-WriteThroughEnabled<SwitchParameter>
Specify this parameter to put all virtual disks created from this template in write-through mode (all write operations to the virtual disk are written directly to the back-end storage and then acknowledged).

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-UseSequentialStorage<SwitchParameter>
Use this parameter to enable or disable the sequential storage property for this template. Specify $true to enable or $false to disable sequential storage.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

VirtualDiskTemplateData : Object that identifies and describes the template.

NOTES

Also see Get-DcsVirtualDiskTemplate, Set-DcsVirtualDiskTemplate, Remove-DcsVirtualDiskTemplate.

EXAMPLES

-------------- Example 1 Creates a template to create a mirrored virtual disk with a 4 KB sector size --------------

Add-DcsVirtualDiskTemplate -Name Temp4KMirror -FirstPool "Disk pool 1" -SecondPool "Disk pool 2" -VirtualDiskSize 50GB -VirtualDiskAlias "MR_4K" -VirtualDiskSectorSize 4096

The cmdlet is invoked to create a virtual disk template named "Temp4KMirror". Virtual disks created from this template will be used to create standard virtual disks with a sector size of 4096 bytes (4 KB). Mirrored virtual disks will be created with a size of "50GB" using "Disk pool 1" as the primary storage source and "Disk pool 2" as the secondary storage source. Servers do not need to be specified since the pool names are unique.

Alias : Temp4KMirror
VirtualDiskAlias : MR_4K
VirtualDiskDescription :
Size : 50 GB
SectorSize : 4 KB
VirtualDiskType : MultiPathMirrored
ReservedSpacePercentage : 0
FirstDiskPoolId : FF140341-D7FC-4DF7-95B3-AE551F099F00:{23e82496-7403-11e5-80e6-00155d138910}
SecondDiskPoolId : 039B77A5-AC1D-4562-8335-7B75CBC636A5:{a5cddc40-7405-11e5-80e6-00155d138914}
UseRedundantMirrorMappings : True
ContinuousDataProtectionPoolId :
ContinuousDataProtectionLogSize : 8 GB
SequentialStorageEnabled : False
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
DefaultSnapshotPoolId :
AllocatedSpaceThresholdAttention : 100
AllocatedSpaceThresholdWarning : 101
AllocatedSpaceThresholdCritical : 101
LatencyThresholdAttention : 5000
LatencyThresholdWarning : 10000
LatencyThresholdCritical : 30000
StorageLatencyThresholdAttention : 5000
StorageLatencyThresholdWarning : 10000
StorageLatencyThresholdCritical : 30000
VirtualDiskSubType : Standard
ReadOnly : False
WriteThroughEnabled : False
MirrorTrunkMappingEnabled : False
SequenceNumber : 8324
Id : 2c11d5d045404b4491b79378b7ccff4e
Caption : Temp4KMirror
ExtendedCaption :
Internal : False
     

To Table of Contents

NAME

Add-DcsVirtualDiskToGroup

SYNOPSIS

Adds a virtual disk to the specified virtual disk group.

SYNTAX

Add-DcsVirtualDiskToGroup   -Group <Object>   -VirtualDisk <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Adds a virtual disk to the specified virtual disk group.

PARAMETERS

-Group<Object>
VirtualDiskGroupData object, name, or ID of the virtual disk group.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-VirtualDisk<Object>
VirtualDiskData object, name or ID of the virtual disk to add to the group. The VirtualDiskData object can be obtained from Get-DcsVirtualDisk.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

VirtualDiskData : Object that identifies and describes the virtual disk.

OUTPUTS

VirtualDiskData : Object that identifies and describes the virtual disk.

NOTES

Also see Get-DcsVirtualDisk, Get-DcsVirtualDiskGroup, Add-DcsVirtualDiskGroup, Remove-DcsVirtualDiskfromGroup, Remove-DcsVirtualDiskGroup.

EXAMPLES

-------------- Example 1 Adds a virtual disk specified by name. --------------

Add-DcsVirtualDiskToGroup -Group "VD Group FTL" -VirtualDisk "Virtual disk 1"

The virtual disk named "Virtual disk 1" is added to the group named "VD Group FTL".

VirtualDiskGroupId : {ef015296-0fa8-4bec-80a9-e312547c94a9}
FirstHostId : D3D14D3A-67A2-4E5F-9FA4-262B812EFFA0
SecondHostId : 431D049E-801E-4061-911E-1493A3F2ECC0
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
Alias : Virtual disk 1
Description :
Size : 20.00 GB
Type : MultiPathMirrored
DiskStatus : Online
InquiryData : DataCore Virtual Disk DCS
ScsiDeviceId : {96, 3, 13, 144...}
RemovableMedia : False
WriteThrough : False
Offline : False
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : False
Id : bd746e02eea248a2bedc66ed71c8eec7
Caption : Virtual disk 1
ExtendedCaption : Virtual disk 1 from Server Group
Internal : False
     

-------------- Example 2 Adds a specific kind of virtual disk to a new virtual disk group --------------

$NewVDgroup = Add-DcsVirtualDiskGroup -Name "VD Group FTL" -Description "Mail server backup for Ft. Lauderdale"

Get-DcsVirtualDisk -ServerGroup "Server Group FTL" -Kind Standard -OnlyWithReplications | Add-DcsVirtualDiskToGroup -Group $NewVDgroup

The cmdlet Add-DcsVirtualDiskGroup is invoked to create a group named "VD Group FTL" with a description of "Mail server backup for Ft. Lauderdale" for the default server group connection. The result is stored in the variable $NewVDgroup.


To Table of Contents

NAME

Add-DcsVirtualLogicalUnit

SYNOPSIS

Adds a front-end or mirror path for the specified logical disk.

SYNTAX

Add-DcsVirtualLogicalUnit   [ -InitiatorHost <String> ]   [ -TargetHost <String> ]   [ -InitiatorPort <String> ]   [ -TargetPort <String> ]   -LogicalDisk <Object>   -MappingType <String>   [ -LUN <UInt64> ]   [ -Access <String> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Adds a front-end or mirror path for the specified logical disk. Virtual disks are created from one (single or dual) or two (mirrored) logical disks (storage sources). This cmdlet will serve the logical disk to a host or create a mirror path if applicable. To serve a mirrored virtual disk to a host, invoke this cmdlet twice; once for each logical disk. Paths can be created by specifying the initiator and target hosts with or without specifying the ports. When ports are not specified, the software will select appropriate ports to create the path.

PARAMETERS

-InitiatorHost<String>
Computer name or ID of the server, or the name or ID of the client host to be used as the initiator. The computer name of a server must be unique or the name must be fully qualified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-TargetHost<String>
Computer name or ID of the server to be used as the target. The computer name must be unique or the name must be fully qualified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-InitiatorPort<String>
Name, ID, or address of the initiator port. To uniquely identify a port by name, the initiator host must be specified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-TargetPort<String>
Name, ID, or address of the target port. To uniquely identify a port by name, the target host must be specified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-LogicalDisk<Object>
LogicalDiskData object, ID or caption that identifies the logical disk of the virtual disk on a server. When creating mirror paths, the logical disk should be the target side of the mapping (path).

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-MappingType<String>
Specify "Mirror" to add a mirror path, or "Client" to add a front-end path.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-LUN<UInt64>
The number to assign to the logical unit (LUN). If not specified, the next available LUN will be assigned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Access<String>
The access rights to assign. Valid values for a client mapping type include "ReadWrite", "ReadOnly", and "NoAccess". The valid value for mirror mapping type is "ReadWrite". If not specified, the default value of "ReadWrite" will be assigned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

LogicalDiskData : Object that identifies and describes the logical disk.

OUTPUTS

VirtualLogicalUnitData : Object that identifies and describes the path of the logical disk.

NOTES

Also see Get-DcsLogicalDisk, Get-DcsVirtualLogicalUnit, Remove-DcsVirtualLogicalUnit, Set-DcsVirtualLogicalUnitProperties.

EXAMPLES

-------------- Example 1 Adds a mirror path for a logical disk in a mirrored virtual disk --------------

$LDisk = Get-DcsLogicalDisk -VirtualDisk "Virtual disk 1"

Add-DcsVirtualLogicalUnit -InitiatorHost "Server2" -InitiatorPort "Server FC Port 1" -TargetHost "Server1" -TargetPort "Server FC Port 2" -LogicalDisk $LDisk[0] -MappingType Mirror

The cmdlet Get-DcsLogicalDisk is invoked to obtain the LogicalDiskData objects that comprise the virtual disk named "Virtual disk 1" and the results are stored in the variable named $LDisk. In this case, Virtual disk 1 is a mirrored virtual disk and has two logical disk objects (storage sources) stored in the variable $LDisk: $LDisk[0] represents the primary side of the mirror, and $LDisk[1] the secondary side. Then the cmdlet Add-DcsVirtualLogicalUnit is invoked to create a mirror mapping (path) between the target on the server named "Server1" and the initiator on the server named Server2" using $LDisk[0], which is the logical disk on the target side of the mapping. The path is identified by the initiator port "Server FC Port 1" on "Server2" and the target port "Server FC Port 2" on "Server1". The mapping type is specified as "Mirror".

LogicalDiskId : LD:D3B57824-4E23-4DBB-947B-F8EF13A6CBAD_V.{1db06ce0-e5f0-11e0-8a13-001d7d93b174}-00000003
VirtualTargetDeviceId : 72f8741f-4485-466b-b5bc-ddf6f494b6d2
Lun : 0
Access : ReadWrite
Type : Mirror
Preferred : True
Enabled : True
Id : 35192e3b-3c8e-4568-9baf-88a001540baf
Caption : Server FC Port 1 on server2 | Server FC Port 2 on Server1 | LUN 0
ExtendedCaption : Server FC Port 1 on server2 | Server FC Port 2 on Server1 | LUN 0
Internal : False
     

-------------- Example 2 Adds a frontend path for a logical disk. --------------

$LDisk = Get-DcsLogicalDisk -VirtualDisk "Virtual disk 1"

Add-DcsVirtualLogicalUnit -InitiatorHost "Host3" -TargetHost "Server1" -InitiatorPort "iSCSI Port 1" -TargetPort "Server iSCSI Port 1" -LogicalDisk $LDisk[0] -MappingType Client -LUN 3

The cmdlet Get-DcsLogicalDisk is invoked to obtain the LogicalDiskData objects that comprise the virtual disk named "Virtual disk 1" and the results are stored in the variable named $LDisk. Then the cmdlet Add-DcsVirtualLogicalUnit is invoked to create a front-end path for the specified logical disk $LDisk[0]. The path is identified as the initiator port "iSCSI Port 1" on the client named "Host3" and the target specified as "Server iSCSI Port 1" on the server named "Server1". The variable $LDisk is used to provide the LogicalDiskData object. The mapping type is specified as "Client", which creates a front-end path and the LUN is specified as "3".

LogicalDiskId : LD:D3B57824-4E23-4DBB-947B-F8EF13A6CBAD_V.{1db06ce0-e5f0-11e0-8a13-001d7d93b174}-00000003
VirtualTargetDeviceId : 7e2a8d17-0018-4eab-8325-a6980da11fb6
Lun : 3
Access : ReadWrite
Type : Client
Preferred : True
Enabled : True
Id : 22cdc3f6-e8c0-493c-904c-ab27e8690598
Caption : iSCSI Port 1 on Host3 | Server iSCSI Port 1 on Server1 | LUN 3
ExtendedCaption : iSCSI Port 1 on Host3 | Server iSCSI Port 1 on Server1 | LUN 3
Internal : False
     

-------------- Example 3 Adds a frontend path without specifying the ports --------------

Add-DcsVirtualLogicalUnit -InitiatorHost "HostVM1" -TargetHost "SSVVM03" -LogicalDisk (Get-DcsLogicalDisk -VirtualDisk "VD1") -MappingType "Client"

A front-end (client) path is created from the initiator on the computer "HostVM1" to a target on the server "SSVVM03" for the logical disk contained in the virtual disk "VD1" on the server "SSVVM03". Since ports are not specified, the software will select the appropriate ports on the specified machines in order to create the specified mapping type.

LogicalDiskId : c3ca5cb7-2b9c-40b7-9591-5591dd8001c7
VirtualTargetDeviceId : af83d50e-5ee4-4a84-924e-63a487c47ec5
PhysicalDiskId : 549da3ce079b49cb9f895d884042722a-4ccc0a8cf91543a6b43aa43d1b677bbe
Lun : 0
Access : ReadWrite
Type : Client
Preferred : NotSet
Enabled : True
SequenceNumber : 27051
Id : 26890758-f8fe-449a-aec7-a4a14c2bf141
Caption : iSCSI Port 1 on HostVM1 | Server iSCSI Port 3 on SSVVM03 | LUN 0
ExtendedCaption : iSCSI Port 1 on HostVM1 | Server iSCSI Port 3 on SSVVM03 | LUN 0
Internal : False
     

To Table of Contents

NAME

Add-DcsWitness

SYNOPSIS

Adds a witness as an object in the server group configuration. This cmdlet is used when adding a witness that will be configured for a specific virtual disk.

SYNTAX

Add-DcsWitness   -Name <String>   -Address <String>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Adds a witness as an object in the server group configuration. This cmdlet is used when adding a witness that will be configured for a specific virtual disk. After the witness is added, set the witness properties for the virtual disk using Set-DcsVirtualDiskWitnessProperties.

PARAMETERS

-Name<String>
Computer name or ID of the server to be added as a witness in the server group. The computer name must be unique or the name must be fully qualified.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Address<String>
The IP address for the witness. For instance, "172.99.999.99".

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias representing the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

WitnessData : Object that identifies the witness.

NOTES

Related cmdlets: Set-DcsServerGroupDefaultWitnessProperties, Set-DcsVirtualDiskWitnessProperties, Set-DcsWitnessProperties, Get-DcsWitness, Remove-DcsWitness, Invoke-DcsWitnessContact.

EXAMPLES

-------------- Example 1 Adds a witness to the server group. --------------

Add-DcsWitness -Name "Witness 2" -Address "172.88.88.888"

The network device with the IP address "172.88.88.888" is added as a witness in the server group and named "Witness 2". The WitnessData object is returned.

Alias : Witness 2
Server :
IPAddress : 172.88.88.888
SequenceNumber : 1232600
Id : 8d15390ca0bb4db5ade39938cac0fd9a
Caption : Witness 2
ExtendedCaption :
Internal : False
     

To Table of Contents

NAME

Backup-DcsConfiguration

SYNOPSIS

Backs up the configuration for each server in the server group and stores it in a file.

SYNTAX

Backup-DcsConfiguration   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Backs up the configuration for each server in the server group and stores it in a file. The file can be used to restore the configuration if necessary. The file will be copied to the folder assigned using Set-DcsBackupFolder.

PARAMETERS

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

ServerHostData : Object that identifies and describes the server.

NOTES

Also see Set-DcsBackupFolder, Get-DcsBackupFolder.

EXAMPLES

-------------- Example 1 Backups the configuration for a server group --------------

Backup-DcsConfiguration

Backups the configuration for both servers in the server group.

GroupId : 626ad5ae-8297-4068-832c-7c476fe32abf
RegionNodeId : ExecutiveNode:A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3
CacheSize : 0.00 B
State : Online
SupportState : Preserving
SnapshotMapStoreId :
SnapshotMapStorePoolId :
InstallPath : C:\Program Files\DataCore\SANsymphony
ProductName : DataCore SANsymphony
ProductType : Standard
ProductVersion : 8.1
OsVersion : Windows Server 2008 R2 x64 Edition, Service Pack 1
ProcessorInfo : DataCore.Executive.ProcessorInformation
ProductBuild : 13.1.0.798
BuildType : Release
DiagnosticMode : Enabled
LicenseRemaining : 23238000000000
ReplicationBufferFolder :
TotalSystemMemory : 1,023.56 MB
AvailableSystemMemory : 136.08 MB
LogStatus : Operational
LicenseSettings : DataCore.Executive.LicenseSettings
IsLicensed : True
StorageUsed : 0.00 B
PowerState : ACOnline
CacheState : WritebackGlobal
BackupStorageFolder : C:\Program Files\DataCore\SANsymphony\Backups\
IpAddresses : {172.20.17.63, fe80::ac9f:4abc:8e7:447a, 13.0.0.31, fe80::2de4:e3b4:87d0:b299...}
Description :
HostName : SSV1.datacoresoftware.com
Id : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3
Caption : SSV1
ExtendedCaption : SSV1 in Server Group
Internal : False
     
GroupId : 626ad5ae-8297-4068-832c-7c476fe32abf
RegionNodeId : ExecutiveNode:781D998D-3920-46BB-9F26-88BC591772B6
CacheSize : 0.00 B
State : Online
SupportState : Preserving
SnapshotMapStoreId :
SnapshotMapStorePoolId :
InstallPath : C:\Program Files\DataCore\SANsymphony
ProductName : DataCore SANsymphony
ProductType : Standard
ProductVersion : 8.1
OsVersion : Windows Server 2008 R2 x64 Edition, Service Pack 1
ProcessorInfo : DataCore.Executive.ProcessorInformation
ProductBuild : 13.1.0.798
BuildType : Release
DiagnosticMode : Enabled
LicenseRemaining : 23274000000000
ReplicationBufferFolder :
TotalSystemMemory : 1,023.56 MB
AvailableSystemMemory : 228.11 MB
LogStatus : Operational
LicenseSettings : DataCore.Executive.LicenseSettings
IsLicensed : True
StorageUsed : 0.00 B
PowerState : ACOnline
CacheState : WritebackGlobal
BackupStorageFolder : C:\Program Files\DataCore\SANsymphony\Backups\
IpAddresses : {172.20.17.157, fe80::2920:ddc6:93a7:45df, 13.0.0.35, fe80::6181:9311:6644:c8d2...}
Description :
HostName : SSV2.datacoresoftware.com
Id : 781D998D-3920-46BB-9F26-88BC591772B6
Caption : SSV2
ExtendedCaption : SSV2 in Server Group
Internal : False
     

To Table of Contents

NAME

Cleanup-DcsServerFCPortDatabase

SYNOPSIS

Cleans or refreshes the port database of Fibre Channel ports.

SYNTAX

Cleanup-DcsServerFCPortDatabase   -Port <Object>   [ -Server <String> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Cleans or refreshes the port database of Fibre Channel ports. All ports that are not present will be removed from the database of remote ports seen by the specified Fibre Channel port on a server.

PARAMETERS

-Port<Object>
ScsiPortData object, name, or ID that identifies the Fibre Channel port. To uniquely identify a port by name, the server must be specified.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Server<String>
Computer name or ID of the server. The computer name must be unique or the name must be fully qualified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

ServerFCPortData : Object the identifies and describes the Fibre Channel port.

OUTPUTS

ServerFCPortData : Object the identifies and describes the Fibre Channel port.

NOTES

Also see Remove-DcsServerPort.

EXAMPLES

-------------- Example 1 Cleanup port database for port specified by name --------------

Cleanup-DcsServerFCPortDatabase -Port "Server FC Port 1" -Server Server1

The port database for the port named "Server FC Port 1" on server "Server1" is cleaned to remove all remote ports that are not present.

StateInfo : DataCore.Executive.FC.FcPortStateInfo
CurrentConfigInfo : DataCore.Executive.FC.FcPortConfigInfo
IdInfo : DataCore.Executive.FC.FcPortIdInfo
CapabilityInfo : DataCore.Executive.FC.FcPortCapabilityInfo
PresenceStatus : Present
PhysicalName : 210000E08B0FEF9A
ServerPortProperties : DataCore.Executive.ServerFcPortPropertiesData
RoleCapability : All
AluaId : 1027
PortName : 21-00-00-E0-8B-0F-EF-9A
Alias : Server FC Port 1
Description :
PortType : FibreChannel
PortMode : InitiatorTarget
HostId : 46921EBF-DC07-4E03-9395-1CEBE4ABE511
Connected : True
SequenceNumber : 1144
Id : dbfe9205-959c-480e-b1d4-d54d0fc0af80
Caption : Server FC Port 1
ExtendedCaption : Server FC Port 1 on Server1
Internal : False
     

To Table of Contents

NAME

Clear-DcsAlert

SYNOPSIS

Deletes all alerts for all servers in the specified connection.

SYNTAX

Clear-DcsAlert   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Deletes all alerts for all servers in the specified connection. After clearing the alerts, the event log messages will remain documented in the Event Log.

PARAMETERS

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

NOTES

Also see Get-DcsAlert, Get-DcsLogMessage, Add-DcsLogMessage.

EXAMPLES

-------------- Example 1 Clears all alerts for a server group --------------

Clear-DcsAlert

Clears all alerts on both servers in the server group.


To Table of Contents

NAME

Clear-DcsLog

SYNOPSIS

Clears all messages from the Event Log.

SYNTAX

Clear-DcsLog   [ -Yes]   [ -Connection <String> ]   [ -PipelineVariable <String> ]   [ -WhatIf]   [ -Confirm]

DESCRIPTION

Clears all messages from the Event Log.

PARAMETERS

-Yes<SwitchParameter>
Deleting log messages is an operation that requires confirmation. Specify this parameter to confirm your intention to permanently delete all log messages and to prevent user interaction during scripted scenarios.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-WhatIf<SwitchParameter>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Confirm<SwitchParameter>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

NOTES

EXAMPLES

-------------- Example 1 Clears the Event Log --------------

Clear-DcsLog -Yes

The cmdlet is invoked to clear all Event Log messages. The parameter Yes is included to confirm the intention to permanently remove all messages and to prevent user interaction while scripts are running.


To Table of Contents

NAME

Connect-DcsiSCSITarget

SYNOPSIS

Creates an iSCSI session connection.

SYNTAX

Connect-DcsiSCSITarget   -InitiatorPort <Object>   [ -Server <String> ]   -Address <String>   [ -PortNumber <UInt16> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Connect-DcsiSCSITarget   -InitiatorPort <Object>   [ -Server <String> ]   -Address <String>   [ -PortNumber <UInt16> ]   [ -UseChap]   [ -UseMutualAuthentication]   [ -InitiatorPortal <String> ]   [ -UserName <String> ]   -Password <String>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Creates an iSCSI session connection. Adds an iSCSI target portal to the Microsoft iSCSI Initiator port of a server and logs in. Authentication can be enabled. If different types of authentication are required for different targets, the cmdlet must be run individually for each authentication type. After invoking this cmdlet, when the target is logged out, the target will disappear and in order to log in the target again, this cmdlet would have to be invoked again.

PARAMETERS

-InitiatorPort<Object>
ScsiPortData object, name, or ID that identifies the Microsoft iSCSI Initiator port. In order to uniquely identify a port by name, the server must be specified.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Server<String>
Computer name or ID of the server. Computer names must be unique or the names must be fully qualified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Address<String>
Address of an iSCSI target port. The address can be a valid server name or IP address.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PortNumber<UInt16>
The TCP port number used for the connection. If not specified, 3260 will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-UseChap<SwitchParameter>
Specify the UseChap parameter to enable authentication.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-UseMutualAuthentication<SwitchParameter>
Specify the UseMutualAuthentication parameter to enable mutual authentication. If UseMutualAuthentication is specified, the parameter UseChap must also be specified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-InitiatorPortal<String>
IP address that identifies the Microsoft iSCSI Initiator port.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-UserName<String>
User name assigned to the target port.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Password<String>
The target secret for the iSCSI target port. Secret is 12-16 characters. Use caution when entering the secret, it will appear as typed on the display.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

ScsiPortData : Object that identifies the initiator port.

OUTPUTS

iSCSISessionData : Object that identifies and describes the session.

NOTES

Also see Disconnect-DcsiSCSITarget, Get-DcsPort, Get-DcsPortConnection, Set-DcsiSCSIInitiatorSecret, Set-DcsServerPortProperties.

EXAMPLES

-------------- Example 1 Creates an iSCSI session using CHAP authentication --------------

Connect-DcsiSCSITarget -InitiatorPort "Microsoft iSCSI Initiator" -Server SSV1 -Address 13.0.0.36 -UseChap -UserName CHAPhandshk -Password 111111111111

Creates an iSCSI session between the initiator port named "Microsoft iSCSI Initiator" on the server named "SSV1" and the iSCSI target port with the IP address of 13.0.0.36 on the server named "SSV2". CHAP authentication is used for the session with a user name of "CHAPhandshk" and password of "111111111111".

PortADescriptor :
PortBDescriptor : DataCore.Executive.iSCSI.SessionDescriptor
Target :
Connected : False
PortAId : FD622C7A-1065-4F2B-97E5-11813DA5AAF5:MAC:00-15-5D-11-E9-22
PortBId : 74EDD1B3-6682-46A7-943C-2F0168CEC699:MSFT-05-1991
Id : 03351a78d471484c8c6815506822255c
Caption : Server iSCSI Port 2 on SSV2 to Microsoft iSCSI Initiator on SSV1
ExtendedCaption : Server iSCSI Port 2 on SSV2 to Microsoft iSCSI Initiator on SSV1
Internal : False
     

To Table of Contents

NAME

Connect-DcsServer

SYNOPSIS

Creates a connection to a server in a server group. When a connection has been created, all servers in the server group can be managed.

SYNTAX

Connect-DcsServer   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Connect-DcsServer   -Server <String>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Connect-DcsServer   -Server <String>   -UserName <String>   -Password <String>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Connect-DcsServer   -Server <String>   -Credential <PSCredential>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Creates a connection to a server in a server group. When a connection has been created, all servers in the server group can be managed. If this cmdlet is invoked without parameters, a connection to the local host using default credentials will be established. This cmdlet can also be invoked to connect to a remote server using the default system credentials (when using PowerShell 3.0 and above).The last connection created is designated as the default connection unless Set-DcsDefaultConnection is invoked to set a specific connection to be the default. A connection is required for each PowerShell session. The Connection parameter is required to invoke all cmdlets and if not specifically designated, the default connection will be used.

PARAMETERS

-Connection<String>
Alias representing the connection to the server group. If other parameter values are specified, but the Connection parameter value is not specified, the server name will be used as the connection alias. If this cmdlet is invoked without parameters, a connection to the local host using default credentials will be established and the connection alias will be "localhost".

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Server<String>
Computer name or IP address of the server to connect to. The computer name must be unique or the name must be fully qualified.

Required: true
Position: 1
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-UserName<String>
The user name of a registered user or the local administrator account. Operating system credentials are used to authenticate users. User names must match Windows operating system user accounts and must reside on all servers in the associated server group.

Required: true
Position: 2
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Password<String>
Login password that corresponds to the registered user name.

Required: true
Position: 3
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Credential<PSCredential>
The PSCredential object containing user name and password. This object can be obtained by invoking the Windows PowerShell cmdlet Get-Credential, see Example 2. In this manner, credentials can be passed through the object instead of typing the credentials.

Required: true
Position: 2
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

string : Alias for the connection.

NOTES

Also see Disconnect-DcsServer, Set-DcsDefaultConnection, Get-DcsDefaultConnection, Get-DcsConnection.

EXAMPLES

-------------- Example 1 Connects to a server with a specified connection name --------------

Connect-DcsServer -Server SSV1 -UserName administrator -Password Adminpw! -Connection SSV1Connect

Connects the server named "SSV1" with the UserName of "Administrator" and Password of "Adminpw!" with the connection named "SSV1Connect".

SSV1Connect
                                

-------------- Example 2 Connects to a server using the Credential parameter --------------

Connect-DcsServer -Server SSVVM1 -Credential(Get-Credential)

The cmdlet Connect-DcsServer is invoked to create a connection through the server named "SSVVM1" using the Credential parameter. The value is obtained by invoking the Windows PowerShell cmdlet Get-Credential. When Get-Credential is invoked a dialog box opens and the user name and password can be entered in a secure manner.

cmdlet Get-Credential at command pipeline position 1
Supply values for the following parameters:
Credential
                                

-------------- Example 3 Connects to a server using a localhost connection --------------

Connect-DcsServer

The cmdlet is invoked without parameters resulting in a connection to the local host using default credentials.

localhost
                                

-------------- Example 4 Connects to a remote server using the local machine credentials --------------

Connect-DcsServer -Server SSV5

The cmdlet Connect-DcsServer is invoked to create a connection through the remote server named "SSV5". When the credentials are not supplied, a connection using the default local machine credentials of the remote server will be attempted. A network connection must exist from the server connecting to the remote server.

localhost
                                

To Table of Contents

NAME

ConvertTo-DcsDualVirtualDisk

SYNOPSIS

Converts a single virtual disk to a dual virtual disk.

SYNTAX

ConvertTo-DcsDualVirtualDisk   -SecondServer <String>   -VirtualDisk <Object>   [ -EnableRedundancy]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Converts a single virtual disk to a dual virtual disk. The single virtual disk must be created from a shared pass-through disk or shared disk pool in order to convert to a dual virtual disk.

PARAMETERS

-SecondServer<String>
Computer name or ID of the new server that will be sharing the virtual disk. The computer name must be unique or the name must be fully qualified. The second server must share the disk pool or pass-through from which the virtual disk was created.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-VirtualDisk<Object>
VirtualDiskData object, name or ID that identifies the single virtual disk. The single virtual disk must be created from a shared disk pool or shared pass-through disk.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-EnableRedundancy<SwitchParameter>
Specify this parameter to create redundant mirror paths between servers. Redundant mirror paths provide two mirror paths going in each direction between servers. Redundant paths can be either iSCSI or Fibre Channel. Each server is required to have two FC or two iSCSI ports with the mirror role enabled (see Set-DcsServerPortProperties). Port paths are automatically selected.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

VirtualDiskData : Object that identifies and describes the virtual disk.

OUTPUTS

VirtualDiskData : Object that identifies and describes a virtual disk.

NOTES

Also see Get-DcsVirtualDisk

EXAMPLES

-------------- Example 1 Converts single virtual disk to dual by specifying the name --------------

ConvertTo-DcsDualVirtualDisk -SecondServer SSV2 -VirtualDisk "Virtual disk 1"

This cmdlet will convert the single virtual disk named "Virtual disk 1" to a dual virtual disk by adding a path to the second server named "SSV2". Server SSV2 shares the pass-through disk from which the virtual disk "Virtual disk 1" was created.

VirtualDiskGroupId :
FirstHostId : 8BD7BD0F-F5F9-40DB-B8B0-6ABB74D43F81
SecondHostId : 8CE05A9F-D367-4BDE-BCE6-67909F6F7F6A
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
Alias : Virtual disk 1
Description :
Size : 200.00 GB
Type : Dual
DiskStatus : FailedRedundancy
InquiryData : DataCore Virtual Disk DCS
ScsiDeviceId : {96, 3, 13, 144...}
ScsiDeviceIdString : 60030D90DF97D7019396376E425BFE64
RemovableMedia : False
WriteThrough : False
Offline : False
Disabled : False
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : False
SequenceNumber : 35437
Id : 8182a9060ee44e738cf395583ad4b018
Caption : Virtual disk 1
ExtendedCaption : Virtual disk 1 from Group LOCAL
Internal : False
     

To Table of Contents

NAME

ConvertTo-DcsFullSnapshot

SYNOPSIS

Converts (promotes) a differential snapshot to a full snapshot. This operation can also be performed on a snapshot group.

SYNTAX

ConvertTo-DcsFullSnapshot   -Snapshot <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

ConvertTo-DcsFullSnapshot   -SnapshotGroup <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Converts (promotes) a differential snapshot to a full snapshot. This operation can also be performed on a snapshot group. The differential (logical copy) will become a clone of the source virtual disk and can exist and operate independently from the source. This operation can be take a considerable amount of time depending on the amount of data that will need to be copied. After the snapshot is converted, it can be split from the source, see Split-DcsSnapshot.

PARAMETERS

-Snapshot<Object>
Name, ID, or SnapshotData object that identifies the differential snapshot.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-SnapshotGroup<Object>
SnapshotGroupData object, name or ID that identifies a snapshot group to convert to full snapshots. Use this parameter to convert all snapshots in the snapshot group to full snapshots. The SnapshotGroupData object can be obtained with Get-DcsVirtualDiskGroup.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

SnapshotData : Object that identifies and describes the snapshot.

OUTPUTS

SnapshotData or SnapshotGroupData : Object that identifies and describes the snapshot or snapshot group that was converted.

NOTES

Also see Get-DcsSnapshot, Get-DcsVirtualDiskGroup, Split-DcsSnapshot, Revert-DcsSnapshot.

EXAMPLES

-------------- Example 1 Promotes a differential snapshot to full image by specifying the name (caption) --------------

ConvertTo-DcsFullSnapshot -Snapshot "VD2 @ 7/28/2011 4:18:14 PM"

Converts the differential snapshot named "VD2 @ 7/28/2011 4:18:14 PM" to a full (clone) snapshot.

SourceLogicalDiskId : LD:74EDD1B3-6682-46A7-943C-2F0168CEC699_V.{267e5c50-abd6-11e0-9515-00155d11e921}-00000014
DestinationLogicalDiskId : LD:74EDD1B3-6682-46A7-943C-2F0168CEC699_V.{b96878da-b7af-11e0-9ba8-00155d11e921}-0000000B
Type : Full
TimeStamp : 7/28/2011 4:18:43 PM
ActiveOperation : NoOperation
State : Healthy
Failure : NoFailure
Id : V.{267E5C50-ABD6-11E0-9515-00155D11E921}-00000014--V.{B96878DA-B7AF-11E0-9BA8-00155D11E921}-0000000B
Caption : VD2 @ 7/28/2011 4:18:14 PM
ExtendedCaption : VD2 @ 7/28/2011 4:18:14 PM on SSV1
Internal : False
     

-------------- Example 2 Promotes differential snapshots in a snapshot group to full snapshots. --------------

ConvertTo-DcsFullSnapshot -SnapshotGroup "VDSnapshotGroup1 @ 11/9/2011 3:30:15 PM"

Converts the differential snapshots in the snapshot group named "VDSnapshotGroup1 @ 11/9/2011 3:30:15 PM" to full (clone) snapshots.

ParentGroupId : {f3e129dd-56bf-40c6-9ebb-e25432138fc6}
Alias : VDSnapshotGroup1 @ 11/9/2011 3:30:15 PM
Description :
Id : {0478ae77-13a2-4153-91cf-9afcbffb867f}
Caption : VDSnapshotGroup1 @ 11/9/2011 3:30:15 PM
ExtendedCaption :
Internal : False
     

-------------- Example 3 Promotes all differential snapshots to full --------------

Get-DcsSnapshot | ConvertTo-DcsFullSnapshot

The cmdlet Get-DcsSnapshot is piped to ConvertTo-DcsFullSnapshot resulting in all differential snapshots being converted (promoted) to full snapshots and the SnapshotData objects returned.

SourceLogicalDiskId : dba9bb6f-4dd7-4017-bf27-6d7166659989
DestinationLogicalDiskId : 61c2100a-4991-4a33-ac4a-a72da684e992
Type : Full
TimeStamp : 3/28/2012 4:02:43 PM
ActiveOperation : NoOperation
State : Healthy
Failure : NoFailure
SequenceNumber : 14951
Id : V.{FCB8BED3-7423-11E1-9F2A-00155D11E92B}-0000001C--V.{FCB8BED3-7423-11E1-9F2A-00155D11E92B}-00000027
Caption : Virtual disk 6 @ 3/28/2012 4:02:35 PM
ExtendedCaption : Virtual disk 6 @ 3/28/2012 4:02:35 PM on SSV3
Internal : False
     
SourceLogicalDiskId : 7693b656-8462-4a08-b9bd-2c181979ed72
DestinationLogicalDiskId : c8dbabdc-727e-4787-b5ee-fa6a7851b910
Type : Full
TimeStamp : 3/28/2012 4:02:24 PM
ActiveOperation : NoOperation
State : Healthy
Failure : NoFailure
SequenceNumber : 14955
Id : V.{FCB8BED3-7423-11E1-9F2A-00155D11E92B}-0000001B--V.{FCB8BED3-7423-11E1-9F2A-00155D11E92B}-00000025
Caption : Virtual disk 5 @ 3/28/2012 4:02:15 PM
ExtendedCaption : Virtual disk 5 @ 3/28/2012 4:02:15 PM on SSV3
Internal : False
     

To Table of Contents

NAME

Disable-DcsDataProtection

SYNOPSIS

Disables Continuous Data Protection (CDP) on a virtual disk or virtual disk group.

SYNTAX

Disable-DcsDataProtection   -VirtualDisk <Object>   [ -Yes]   [ -Connection <String> ]   [ -PipelineVariable <String> ]   [ -WhatIf]   [ -Confirm]

Disable-DcsDataProtection   -VirtualDiskGroup <Object>   [ -Yes]   [ -Connection <String> ]   [ -PipelineVariable <String> ]   [ -WhatIf]   [ -Confirm]

DESCRIPTION

Disables Continuous Data Protection (CDP) on a virtual disk or virtual disk group. When disabled, the history log is deleted and the virtual disk will no longer have Continuous Data Protection. All rollbacks created from the CDP-enabled virtual disk will be deleted. NOTE: Disabling at the group level will disable all eligible healthy group members on all servers.

PARAMETERS

-VirtualDisk<Object>
VirtualDiskData object, name, or ID that identifies the CDP-enabled virtual disk. The VirtualDiskData object can be obtained with Get-DcsVirtualDisk.

Required: true
Position: 1
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Yes<SwitchParameter>
When Continuous Data Protection is disabled on a virtual disk, all rollbacks created from that virtual disk will be deleted. Disabling Continuous Data Protection when rollbacks exist will result in a confirmation message. Specify this parameter to confirm your intention to disable Continuous Data Protection when rollbacks exist in order to prevent user interaction during scripted scenarios.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-WhatIf<SwitchParameter>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Confirm<SwitchParameter>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-VirtualDiskGroup<Object>
VirtualDiskGroupData object, name or ID that identifies a virtual disk group. Use this parameter to disable Continuous Data Protection for all eligible virtual disks in the virtual disk group. The VirtualDiskGroupData object can be obtained with Get-DcsVirtualDiskGroup.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

VirtualDiskData : Object that identifies and describes the virtual disk.

OUTPUTS

VirtualDiskData or VirtualDiskGroupData : Object that identifies and describes the virtual disk or virtual disk group.

NOTES

Also see Enable-DcsDataProtection, Romove-DcsRollback, Split-DcsRollback, Get-DcsVirtualDisk, Get-DcsVirtualDiskGroup.

EXAMPLES

-------------- Example 1 Disables Continuous Data Protection for a virtual disk specified by name (caption) --------------

Disable-DcsDataProtection -VirtualDisk VDisk3 -Yes

Disables the feature for the virtual disk named "VDisk3". The Yes parameter was included to eliminate the need to confirm the operation.

GroupId :
FirstHostId : 4B24F2B0-9A98-4C9E-9996-4E7B89FD6BA9
SecondHostId : 22885568-1C03-4F7D-B95B-5C9C3AA16125
BackupHostId :
Alias : VDisk1
VirtualDiskGroupId :
FirstHostId : 74EDD1B3-6682-46A7-943C-2F0168CEC699
SecondHostId :
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
Alias : VDisk3
Description :
Size : 10.00 GB
Type : NonMirrored
DiskStatus : Online
InquiryData : DataCore Virtual Disk DCS
ScsiDeviceId : {96, 3, 13, 144...}
RemovableMedia : False
WriteThrough : False
Offline : False
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : False
Id : bc1d2b2d679145698e2029415ea86724
Caption : VDisk3
ExtendedCaption : VDisk3 from LOCAL
Internal : False
     

-------------- Example 2 Disable Continuous Data Protection for a virtual disk group --------------

Disable-DcsDataProtection -VirtualDiskGroup VDDataProtectionGroup1 -Yes

Disables the feature for the virtual disk group named "VDDataProtectionGroup1". The Yes parameter was included to eliminate the need to confirm the operation.

Alias : VDDataProtectionGroup1
Description :
Id : {106c2602-5942-4419-af18-bb7412f2fd0b}
Caption : VDDataProtectionGroup1
ExtendedCaption :
Internal : False
     

To Table of Contents

NAME

Disable-DcsReplicationTestMode

SYNOPSIS

Disables replication test mode for a local standby virtual disk.

SYNTAX

Disable-DcsReplicationTestMode   -Replication <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Disable-DcsReplicationTestMode   -VirtualDiskGroup <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Disables replication test mode for a local standby virtual disk. Data changes on the standby virtual disk made during test mode will be deleted when test mode is disabled. Warning: Disabling test mode can take a considerable amount of time and can affect performance.

PARAMETERS

-Replication<Object>
AsyncReplicationData object, VirtualDiskData object, Async Replication ID, virtual disk name, or virtual disk ID that identifies the standby (destination) virtual disk in the replication. The standby virtual disk must be in the local server group.

Required: true
Position: 1
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-VirtualDiskGroup<Object>
VirtualDiskGroupData object, name or ID that identifies a virtual disk group. Use this parameter to disable test mode for all eligible virtual disks in the virtual disk group. Eligibility may not apply to all virtual disks in the group. The VirtualDiskGroupData object can be obtained with Get-DcsVirtualDiskGroup.

Required: true
Position: 1
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

AsyncReplicationData or VirtualDiskData : Object that identifies the standby virtual disk in a replication.

OUTPUTS

AsyncReplicationData : Object that identifies and describes the relationship between the Active (source) and standby (destination) virtual disks in the replication.

NOTES

Also see Enable-DcsReplicationTestMode, Get-DcsReplication.

EXAMPLES

-------------- Example 1 Disables test mode for a virtual disk specified by name --------------

Disable-DcsReplicationTestMode -Replication RepVD1

Test mode is disabled on the standby virtual disk named "RepVD1" in the local server group.

FirstServerId : D3D14D3A-67A2-4E5F-9FA4-262B812EFFA0
FirstVirtualDiskId : a407b0413f9348a2bf645a14d9cf7c57
SecondServerId : a6c68fe8-ea6f-420f-b791-278a02a176eb:AA56BE97-83F3-45B0-B81C-2184A8083E68
SecondVirtualDiskId : d3a0fbdd7eae488a936cea47d31ddfd9
IsActiveSide : False
ReplicationState : Standby
FailureStatus : NoFailure
TransferStatus : Enabled
Paused : False
CheckpointSnapshotId :
AutoAsyncReplicationLicense : Enabled
OfflineInitializationSupported : True
InitializationType : Online
OfflineInitializationBuffer :
OfflineInitStatus : NoOfflineInit
InitializationFailureStatus : NoFailure
TestModeStatus : Active
Id : 3e017326-4f28-417e-bbd2-6dd238743902
Caption : RepVD1
ExtendedCaption : RepVD1 on SSVVM3
Internal : False
     

-------------- Example 2 Disables test mode on all standby virtual disks --------------

Get-DcsReplication -ShowOnlyLocalSide | Disable-DcsReplicationTestMode

The cmdlet Get-DcsReplication is invoked on the destination (standby) partner to obtain AsyncReplicationData objects for all local standby virtual disks. Those objects are piped to Disable-DcsReplicationTestMode to disable test mode for those virtual disks in the local server group.

FirstServerId : D3D14D3A-67A2-4E5F-9FA4-262B812EFFA0
FirstVirtualDiskId : a407b0413f9348a2bf645a14d9cf7c57
SecondServerId : a6c68fe8-ea6f-420f-b791-278a02a176eb:AA56BE97-83F3-45B0-B81C-2184A8083E68
SecondVirtualDiskId : d3a0fbdd7eae488a936cea47d31ddfd9
IsActiveSide : False
ReplicationState : Standby
FailureStatus : Offline
TransferStatus : Enabled
Paused : False
CheckpointSnapshotId :
AutoAsyncReplicationLicense : Enabled
OfflineInitializationSupported : True
InitializationType : Online
OfflineInitializationBuffer :
OfflineInitStatus : NoOfflineInit
InitializationFailureStatus : NoFailure
TestModeStatus : Active
Id : 3e017326-4f28-417e-bbd2-6dd238743902
Caption : Virtual disk 1
ExtendedCaption : Virtual disk 1 on SSVVM3
Internal : False
     
FirstServerId : D3D14D3A-67A2-4E5F-9FA4-262B812EFFA0
FirstVirtualDiskId : 656bb58c14af4e60ac42daf3db74eacd
SecondServerId : a6c68fe8-ea6f-420f-b791-278a02a176eb:AA56BE97-83F3-45B0-B81C-2184A8083E68
SecondVirtualDiskId : 537cd02923d7487bb8371da08d5bcf8e
IsActiveSide : False
ReplicationState : Standby
FailureStatus : NoFailure
TransferStatus : Enabled
Paused : False
CheckpointSnapshotId :
AutoAsyncReplicationLicense : Enabled
OfflineInitializationSupported : True
InitializationType : Online
OfflineInitializationBuffer :
OfflineInitStatus : NoOfflineInit
InitializationFailureStatus : NoFailure
TestModeStatus : Active
Id : b48a5f68-9861-4948-b902-0ad1dae78e43
Caption : Virtual disk 2
ExtendedCaption : Virtual disk 2 on SSVVM3
Internal : False
     

To Table of Contents

NAME

Disable-DcsSequentialStorage

SYNOPSIS

Disables the sequential storage setting for a virtual disk or virtual disk group.

SYNTAX

Disable-DcsSequentialStorage   -VirtualDisk <Object>   [ -Yes]   [ -Connection <String> ]   [ -PipelineVariable <String> ]   [ -WhatIf]   [ -Confirm]

Disable-DcsSequentialStorage   -VirtualDiskGroup <Object>   [ -Yes]   [ -Connection <String> ]   [ -PipelineVariable <String> ]   [ -WhatIf]   [ -Confirm]

DESCRIPTION

Disables the sequential storage setting for a virtual disk or virtual disk group. NOTE: In order to disable at the group level, all group members must be healthy and all affected server must be running. All eligible group members will be disabled and members that are already disabled will be skipped.

PARAMETERS

-VirtualDisk<Object>
VirtualDiskData object, name, or ID that identifies the virtual disk.

Required: true
Position: 1
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Yes<SwitchParameter>
Disabling sequential storage will result in a confirmation message. Specify this parameter to confirm your intention to disable the sequential storage setting in order to prevent user interaction during scripted scenarios.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-WhatIf<SwitchParameter>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Confirm<SwitchParameter>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-VirtualDiskGroup<Object>
VirtualDiskGroupData object, name or ID that identifies a virtual disk group. Use this parameter to enable sequential storage for all eligible virtual disks in the virtual disk group. The VirtualDiskGroupData object can be obtained with Get-DcsVirtualDiskGroup.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

VirtualDiskData : Object that identifies and describes the virtual disk.

OUTPUTS

VirtualDiskData or VirtualDiskGroupData : Object that identifies and describes the virtual disk or virtual disk group.

NOTES

Also see Enable-DcsSequentialStorage, Get-DcsVirtualDisk, Get-DcsVirtualDiskGroup

EXAMPLES

-------------- Example 1 Disables sequential storage for a specified virtual disk --------------

Disable-DcsSequentialStorage -VirtualDisk "Virtual disk 1"

The sequential storage setting is disabled for the virtual disk named "Virtual disk 1".

VirtualDiskGroupId :
FirstHostId : BB3877BA-4FC9-4429-8D1F-D57D23808ED6
SecondHostId : D4DB7B7A-67F5-4ECB-8350-166057170F7D
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
SnapshotPoolId :
Alias : Virtual disk 1
Description :
Size : 20 GB
Type : MultiPathMirrored
DiskStatus : Online
InquiryData : DataCore Virtual Disk DCS dc1df97ee1454f3482a54c456ebc209a
ScsiDeviceId : {96, 3, 13, 144...}
ScsiDeviceIdString : 60030D90B5F1CE06C7E2F4F65FE4CE85
RemovableMedia : False
WriteThrough : False
Offline : False
Disabled : False
ManualRecovery : False
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : False
SequenceNumber : 3194
Id : dc1df97ee1454f3482a54c456ebc209a
Caption : Virtual disk 1
ExtendedCaption : Virtual disk 1 from Group1
Internal : False
     

To Table of Contents

NAME

Disable-DcsServerWriteCache

SYNOPSIS

Disables write caching for the specified server.

SYNTAX

Disable-DcsServerWriteCache   -Server <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Disables write caching for the specified server. When disabled, all write operations from client hosts will be written directly to the back-end storage and then acknowledged.

PARAMETERS

-Server<Object>
ServerHostData object, computer name, or ID that identifies the server. The computer name must be unique or the name must be fully qualified.

Required: true
Position: 1
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias representing the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

ServerHostData : Object that identifies and describes the server.

OUTPUTS

ServerHostData : Object that identifies and describes the server.

NOTES

Also see Enable-DcsServerWriteCache.

EXAMPLES

-------------- Example 1 Disables write caching on a server specified by name (caption) --------------

Disable-DcsServerWriteCache -Server SSV1

Disables write caching on the server named "SSV1". All write I/Os will be written directly to back-end storage.

GroupId : d9ecaccf-9a7c-48f3-8d83-c4ebb5811672
RegionNodeId : ExecutiveNode:74EDD1B3-6682-46A7-943C-2F0168CEC699
CacheSize : 0.00 B
State : Online
SupportState : Idle
SnapshotMapStoreId : V.{b9687922-b7af-11e0-9ba8-00155d11e921}-00000001
SnapshotMapStorePoolId : 74EDD1B3-6682-46A7-943C-2F0168CEC699:{b9687922-b7af-11e0-9ba8-00155d11e921}
InstallPath : C:\Program Files\DataCore\SANsymphony
ProductName : DataCore SANsymphony
ProductType : Standard
ProductVersion : 8.1
OsVersion : Windows Server 2008 R2 x64 Edition, Service Pack 1
ProcessorInfo : DataCore.Executive.ProcessorInformation
ProductBuild : 13.1.0.755
BuildType : Release
DiagnosticMode : Enabled
LicenseRemaining : 23352926053750
ReplicationBufferFolder : E:\
TotalSystemMemory : 1,023.56 MB
AvailableSystemMemory : 58.82 MB
LogStatus : Operational
LicenseSettings : DataCore.Executive.LicenseSettings
IsLicensed : False
StorageUsed : 0.00 B
PowerState : ACOnline
CacheState : WritethruGlobal
BackupStorageFolder :
IpAddresses : {172.20.17.63, fe80::ac9f:4abc:8e7:447a, 13.0.0.31, fe80::2de4:e3b4:87d0:b299...}
Description :
HostName : SSV1.datacoresoftware.com
Id : 74EDD1B3-6682-46A7-943C-2F0168CEC699
Caption : SSV1
ExtendedCaption : SSV1 in LOCAL
Internal : False
     

To Table of Contents

NAME

Disable-DcsTask

SYNOPSIS

Disables a task.

SYNTAX

Disable-DcsTask   -Task <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Disables a task. The task will not run again until enabled.

PARAMETERS

-Task<Object>
TaskData object, name, or ID that identifies the task.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

TaskData : Object that identifies and describes the task.

OUTPUTS

TaskData : Object that identifies and describes the task.

NOTES

Also see Get-DcsTask, Enable-DcsTask.

EXAMPLES

-------------- Example 1 Disables a task specified by name (caption) --------------

Disable-DcsTask -Task MyNightlyTask

Disables the task named "MyNightlyTask". The task will not run again until enabled.

Description : Start Virtual Disk Reclamation at 2 am
Enabled : False
ActionBehavior : RunPerTrigger
MaxRunTime : 6048000000000
Connective : LogicalAnd
ActionDelay : 0
State : Idle
CurrentActionId :
LastStartTime : 1/1/0001 12:00:00 AM
LastStopTime : 1/1/0001 12:00:00 AM
Id : e0b61456-55b1-4f09-9567-39586e71ef16
Caption : MyNightlyTask
ExtendedCaption : MyNightlyTask
Internal : False
     

-------------- Example 2 Disables all tasks by piping objects --------------

Get-DcsTask | Disable-DcsTask

Disables all enabled tasks on servers in the server group. The task objects were obtained using the Get-DcsTask cmdlet.

Description :
Enabled : False
ActionBehavior : RunPerTrigger
MaxRunTime : 6048000000000
Connective : LogicalOr
ActionDelay : 0
State : Idle
CurrentActionId :
LastStartTime : 1/1/0001 12:00:00 AM
LastStopTime : 1/1/0001 12:00:00 AM
Id : 32651f76-72e9-4852-ba35-0b111eaa7808
Caption : Task 1
ExtendedCaption : Task 1
Internal : False
     
Description :
Enabled : False
ActionBehavior : RunPerTrigger
MaxRunTime : 6048000000000
Connective : LogicalOr
ActionDelay : 0
State : Idle
CurrentActionId :
LastStartTime : 1/1/0001 12:00:00 AM
LastStopTime : 1/1/0001 12:00:00 AM
Id : b72c3fac-61d0-4641-95f1-1c310b7c322d
Caption : Task 2
ExtendedCaption : Task 2
Internal : False
     

To Table of Contents

NAME

Disable-DcsVirtualDiskAutoRecovery

SYNOPSIS

Disables automatic mirror recovery for a virtual disk or virtual disk group.

SYNTAX

Disable-DcsVirtualDiskAutoRecovery   -VirtualDisk <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]   [ -WhatIf]   [ -Confirm]

Disable-DcsVirtualDiskAutoRecovery   -VirtualDiskGroup <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]   [ -WhatIf]   [ -Confirm]

DESCRIPTION

Disables automatic mirror recovery for a virtual disk or virtual disk group. After disabling auto-recovery, mirror recovery must be manually started, see Resume-DcsVirtualDiskRecovery.

PARAMETERS

-VirtualDisk<Object>
VirtualDiskData object, name, or ID that identifies the virtual disk.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-WhatIf<SwitchParameter>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Confirm<SwitchParameter>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-VirtualDiskGroup<Object>
VirtualDiskGroupData object, name or ID that identifies a virtual disk group. When the operation is performed on a virtual disk group, auto-recovery will be disabled for all eligible virtual disks in the group and the rest will be ignored.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

VirtualDiskData : Object that identifies and describes the virtual disk.

OUTPUTS

VirtualDiskData : Object that identifies and describes the virtual disk.

NOTES

Also see Enable-DcsVirtualDiskAutoRecovery, Get-DcsVirtualDisk, Get-DcsVirtualDiskGroup, Resume-DcsVirtualDiskRecovery, Pause-DcsVirtualDiskRecovery.

EXAMPLES

-------------- Example 1 Disables auto recovery for all virtual disks on a specified server --------------

Get-DcsVirtualDisk -Server SSV1 | Disable-DcsVirtualDiskAutoRecovery

The cmdlet Get-DcsVirtualDisk is invoked to get VirtualDiskData objects for all virtual disks on the server named "SSV1." The results are piped to the cmdlet Disable-DcsVirtualDiskAutoRecovery to disable auto-recovery for all eligible virtual disks. A VirtualDiskData object is returned for each virtual disk that has been disabled.

VirtualDiskGroupId :
FirstHostId : E9D5564F-D72A-4C5C-AA0F-B2C23A3AD093
SecondHostId : BBA07A42-44F1-40A6-A0E0-756351FFE386
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
SnapshotPoolId :
Alias : Virtual disk 1
Description :
Size : 50.00 GB
Type : MultiPathMirrored
DiskStatus : Online
InquiryData : DataCore Virtual Disk DCS ec6a87754077499dbe1eda213c6df2e0
ScsiDeviceId : {96, 3, 13, 144...}
ScsiDeviceIdString : 60030D90446DFE01504F9B5BE7187E6F
RemovableMedia : False
WriteThrough : False
Offline : False
Disabled : False
ManualRecovery : True
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : True
SequenceNumber : 35198
Id : ec6a87754077499dbe1eda213c6df2e0
Caption : Virtual disk 1
ExtendedCaption : Virtual disk 1 from Group1
Internal : False
     
VirtualDiskGroupId :
FirstHostId : E9D5564F-D72A-4C5C-AA0F-B2C23A3AD093
SecondHostId : BBA07A42-44F1-40A6-A0E0-756351FFE386
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
SnapshotPoolId :
Alias : Virtual disk 4
Description :
Size : 45.00 GB
Type : MultiPathMirrored
DiskStatus : Online
InquiryData : DataCore Virtual Disk DCS c342896abdbb4de9ba009e9ee63fa815
ScsiDeviceId : {96, 3, 13, 144...}
ScsiDeviceIdString : 60030D903E7D6C078ED2765BEE1ADBCA
RemovableMedia : False
WriteThrough : False
Offline : False
Disabled : False
ManualRecovery : True
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : True
SequenceNumber : 35200
Id : c342896abdbb4de9ba009e9ee63fa815
Caption : Virtual disk 4
ExtendedCaption : Virtual disk 4 from Group1
Internal : False
     
VirtualDiskGroupId :
FirstHostId : E9D5564F-D72A-4C5C-AA0F-B2C23A3AD093
SecondHostId : BBA07A42-44F1-40A6-A0E0-756351FFE386
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
SnapshotPoolId :
Alias : Virtual disk 6
Description :
Size : 10.00 GB
Type : MultiPathMirrored
DiskStatus : Online
InquiryData : DataCore Virtual Disk DCS 26599ea3d8704c668b0c6ee048c00653
ScsiDeviceId : {96, 3, 13, 144...}
ScsiDeviceIdString : 60030D90E6876C07DBC76ADE1851A94A
RemovableMedia : False
WriteThrough : False
Offline : False
Disabled : False
ManualRecovery : True
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : True
SequenceNumber : 35202
Id : 26599ea3d8704c668b0c6ee048c00653
Caption : Virtual disk 6
ExtendedCaption : Virtual disk 6 from Group1
Internal : False
     
VirtualDiskGroupId : {94add581-0054-4317-95c7-f6f81309370b}
FirstHostId : E9D5564F-D72A-4C5C-AA0F-B2C23A3AD093
SecondHostId : BBA07A42-44F1-40A6-A0E0-756351FFE386
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
SnapshotPoolId :
Alias : Virtual disk 2
Description :
Size : 10.00 GB
Type : MultiPathMirrored
DiskStatus : Online
InquiryData : DataCore Virtual Disk DCS a55059113f1e424895f4eea7751aa546
ScsiDeviceId : {96, 3, 13, 144...}
ScsiDeviceIdString : 60030D906348F000688BBA02259ABAE1
RemovableMedia : False
WriteThrough : False
Offline : False
Disabled : False
ManualRecovery : True
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : False
SequenceNumber : 35205
Id : a55059113f1e424895f4eea7751aa546
Caption : Virtual disk 2
ExtendedCaption : Virtual disk 2 from Group1
Internal : False
     

-------------- Example 2 Disables auto recovery for all virtual disk groups --------------

Disable-DcsVirtualDiskAutoRecovery -VirtualDiskGroup VDGroup1

The cmdlet Get-DcsVirtualDiskGroup is invoked to get all VirtualDiskGroupData objects for the local server group. Those objects are used as the values for the parameter VirtualDiskGroup. Auto-recovery is disabled for all eligible virtual disks in all virtual disk groups in the local server group. A VirtualDiskData object is returned for each virtual disk that has been disabled.

VirtualDiskGroupId : {94add581-0054-4317-95c7-f6f81309370b}
FirstHostId : E9D5564F-D72A-4C5C-AA0F-B2C23A3AD093
SecondHostId : BBA07A42-44F1-40A6-A0E0-756351FFE386
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
SnapshotPoolId :
Alias : Virtual disk 2
Description :
Size : 10.00 GB
Type : MultiPathMirrored
DiskStatus : Online
InquiryData : DataCore Virtual Disk DCS a55059113f1e424895f4eea7751aa546
ScsiDeviceId : {96, 3, 13, 144...}
ScsiDeviceIdString : 60030D906348F000688BBA02259ABAE1
RemovableMedia : False
WriteThrough : False
Offline : False
Disabled : False
ManualRecovery : True
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : False
SequenceNumber : 35329
Id : a55059113f1e424895f4eea7751aa546
Caption : Virtual disk 2
ExtendedCaption : Virtual disk 2 from Group1
Internal : False
     

To Table of Contents

NAME

Disconnect-DcsiSCSITarget

SYNOPSIS

Logs out an iSCSI target port from the Microsoft Initiator on a server.

SYNTAX

Disconnect-DcsiSCSITarget   [ -Server <String> ]   [ -InitiatorPort <String> ]   -Session <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Logs out an iSCSI target port from the Microsoft Initiator on a server.

PARAMETERS

-Server<String>
Computer name or ID of the server. The computer name must be unique or the name must be fully qualified.

Required: false
Position: 1
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-InitiatorPort<String>
Name, or ID that identifies the Microsoft iSCSI Initiator port. In order to uniquely identify a port by name, the server must be specified.

Required: false
Position: 2
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Session<Object>
iSCSISessionData object or ID that identifies the session to disconnect.

Required: true
Position: 3
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

iSCSiSessionData : Object that identifies and describes the iSCSI session.

OUTPUTS

iSCSiSessionData : Object that identifies and describes the iSCSI session.

NOTES

Also see Connect-DcsiSCSITarget, Remove-DcsServerPort, Get-DcsPort, Get-DcsPortConnection.

EXAMPLES

-------------- Example 1 Logs out a specified target port by piping the object --------------

Get-DcsPortConnection -ConnectionType iSCSI -Machine SSV2 -Port "Server iSCSI Port 1" | Disconnect-DcsiSCSITarget -Server SSV1 -InitiatorPort "Microsoft iSCSI Initiator"

Logs out the target port named "Server iSCSI Port 1" on the server named "SSV2" from the initiator port named "Microsoft iSCSI Initiator" on the server named "SSV1". The session object was obtained using the Get-DcsPortConnection cmdlet.

PortADescriptor : DataCore.Executive.iSCSI.SessionDescriptor
PortBDescriptor : DataCore.Executive.iSCSI.SessionDescriptor
Target :
Connected : False
PortAId : 781D998D-3920-46BB-9F26-88BC591772B6:MAC:00-15-5D-11-E9-10
PortBId : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3:MSFT-05-1991
Id : 19422f2c70684923beff0b9a789fb76a
Caption : Server iSCSI Port 1 on SSV2 to Microsoft iSCSI Initiator on SSV1
ExtendedCaption : Server iSCSI Port 1 on SSV2 to Microsoft iSCSI Initiator on SSV1
Internal : False
     

-------------- Example 2 Logs out all target ports of a server by piping the objects --------------

Get-DcsPortConnection -ConnectionType iSCSI -Machine SSV2 | Disconnect-DcsiSCSITarget -Server SSV1 -InitiatorPort "Microsoft iSCSI Initiator"

Logs out all target ports belonging to server SSV2 from the Microsoft iSCSI Initiator on server SSV1. In this case there are four target ports. The session object was obtained using the Get-DcsPortConnection cmdlet.

PortADescriptor :
PortBDescriptor : DataCore.Executive.iSCSI.SessionDescriptor
Target :
Connected : False
PortAId : 781D998D-3920-46BB-9F26-88BC591772B6:MAC:00-15-5D-11-E9-10
PortBId : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3:MSFT-05-1991
Id : 19422f2c70684923beff0b9a789fb76a
Caption : Server iSCSI Port 1 on SSV2 to Microsoft iSCSI Initiator on SSV1
ExtendedCaption : Server iSCSI Port 1 on SSV2 to Microsoft iSCSI Initiator on SSV1
Internal : False
     
PortADescriptor : DataCore.Executive.iSCSI.SessionDescriptor
PortBDescriptor : DataCore.Executive.iSCSI.SessionDescriptor
Target :
Connected : False
PortAId : 781D998D-3920-46BB-9F26-88BC591772B6:MAC:00-15-5D-11-E9-23
PortBId : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3:MSFT-05-1991
Id : aea86468f600412487fd9e8c606fe5fb
Caption : Server iSCSI Port 4 on SSV2 to Microsoft iSCSI Initiator on SSV1
ExtendedCaption : Server iSCSI Port 4 on SSV2 to Microsoft iSCSI Initiator on SSV1
Internal : False
     
PortADescriptor : DataCore.Executive.iSCSI.SessionDescriptor
PortBDescriptor : DataCore.Executive.iSCSI.SessionDescriptor
Target :
Connected : False
PortAId : 781D998D-3920-46BB-9F26-88BC591772B6:MAC:00-15-5D-11-E9-22
PortBId : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3:MSFT-05-1991
Id : 1095330d613040c78c8d280fbe2d2368
Caption : Server iSCSI Port 3 on SSV2 to Microsoft iSCSI Initiator on SSV1
ExtendedCaption : Server iSCSI Port 3 on SSV2 to Microsoft iSCSI Initiator on SSV1
Internal : False
     
PortADescriptor : DataCore.Executive.iSCSI.SessionDescriptor
PortBDescriptor : DataCore.Executive.iSCSI.SessionDescriptor
Target :
Connected : False
PortAId : 781D998D-3920-46BB-9F26-88BC591772B6:MAC:00-15-5D-11-E9-18
PortBId : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3:MSFT-05-1991
Id : ab270dc1972d4666a829afe7e7cd94d8
Caption : Server iSCSI Port 2 on SSV2 to Microsoft iSCSI Initiator on SSV1
ExtendedCaption : Server iSCSI Port 2 on SSV2 to Microsoft iSCSI Initiator on SSV1
Internal : False
     

To Table of Contents

NAME

Disconnect-DcsServer

SYNOPSIS

Disconnects from the server in a server group connection.

SYNTAX

Disconnect-DcsServer   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Disconnects from the server in a server group connection. The connection will be removed. If the connection being removed is the default connection and other connections exist, the connection created before this connection will be designated as the new default connection.

PARAMETERS

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: 1
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

string : Alias that identifies the connection.

OUTPUTS

string : Message that the action has been successfully completed.

NOTES

Also see Get-DcsDefaultConnection, Set-DcsDefaultConnection, Get-DcsConnection, Connect-DcsServer.

EXAMPLES

-------------- Example 1 Disconnects a specified connection --------------

Disconnect-DcsServer -Connection SSV2Connect

Disconnects the connection named "SSV2Connect". This connection can no longer be used in cmdlets until or unless the connection is re-established.

Disconnecting SSV2Connect...
Disconnected successfully
                                

To Table of Contents

NAME

Enable-DcsDataProtection

SYNOPSIS

Enables Continuous Data Protection (CDP) for a virtual disk. This operation can also be performed on a virtual disk group.

SYNTAX

Enable-DcsDataProtection   [ -Server <String> ]   -VirtualDisk <Object>   -Pool <String>   [ -HistorySize <DataSize> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Enable-DcsDataProtection   [ -Server <String> ]   -VirtualDiskGroup <Object>   -Pool <String>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Enables Continuous Data Protection (CDP) for a virtual disk. This operation can also be performed on a virtual disk group. When enabled, data changes are saved in a history log. If necessary, rollbacks can be created to recover data, see Add-DcsRollback. NOTE: In order to enable this feature at the group level, all group members must be eligible for Continuous Data Protection and not already be enabled; otherwise, members must be enabled individually.

PARAMETERS

-Server<String>
Computer name or ID of the server that will own the history log. The computer name must be unique or the name must be fully qualified.

Required: false
Position: 3
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-VirtualDisk<Object>
VirtualDiskData object, name, or ID that identifies the virtual disk to protect.

Required: true
Position: 1
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Pool<String>
Name or ID of the disk pool to use as the source of the history log. To resolve by name, the name must be unique to the server group or the server must be specified.

Required: true
Position: 2
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-HistorySize<DataSize>
The maximum size of the history log. Valid values consist of the number followed by the unit of measurement (MB, GB, TB). Decimals may be used. For example, "10GB", "20.5GB", and "5000MB" are valid sizes. The history log size can range from a minimum of 8GB up to 1024TB. If not specified, the history log size will be set to the default size which is 5% of the size of the CDP-enabled virtual disk or 8GB, whichever is larger. Setting the value of this parameter to zero will also set the maximum history log size to the default size.

Required: false
Position: 4
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-VirtualDiskGroup<Object>
VirtualDiskGroupData object, name or ID that identifies a virtual disk group. Use this parameter to enable Continuous Data Protection for all eligible virtual disks in the virtual disk group. The VirtualDiskGroupData object can be obtained with Get-DcsVirtualDiskGroup.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

VirtualDiskData : Object that identifies and describes the virtual disk.

OUTPUTS

VirtualDiskData or VirtualDiskGroupData : Object that identifies and describes the virtual disk or virtual disk group.

NOTES

Also see Add-DcsRollback, Disable-DcsDataProtection, Get-DcsVirtualDisk, Get-DcsVirtualDiskGroup.

EXAMPLES

-------------- Example 1 Enables Continuous Data Protection for all virtual disks by piping objects --------------

Get-DcsVirtualDisk | Enable-DcsDataProtection -Server SSV2 -Pool "Disk Pool 1" -HistorySize 15GB

The cmdlet Get-DcsVirtualDisk is used to pipe all objects to Enable-DcsDataProtection, which results in all virtual disks being enabled for Continuous Data Protection. The history logs for each virtual disk are created on server SSV2 with a maximum size of 15 GB.

VirtualDiskGroupId :
FirstHostId : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3
SecondHostId : 781D998D-3920-46BB-9F26-88BC591772B6
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
Alias : Virtual disk 2
Description :
Size : 10.00 GB
Type : MultiPathMirrored
DiskStatus : Online
InquiryData : DataCore Virtual Disk DCS
ScsiDeviceId : {96, 3, 13, 144...}
RemovableMedia : False
WriteThrough : False
Offline : False
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : False
Id : f692ff225118499ca8c2aaed4c2a91d2
Caption : Virtual disk 2
ExtendedCaption : Virtual disk 2 from Ft. Lauderdale
Internal : False
     
VirtualDiskGroupId :
FirstHostId : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3
SecondHostId : 781D998D-3920-46BB-9F26-88BC591772B6
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
Alias : Virtual disk 1
Description :
Size : 10.00 GB
Type : MultiPathMirrored
DiskStatus : Online
InquiryData : DataCore Virtual Disk DCS
ScsiDeviceId : {96, 3, 13, 144...}
RemovableMedia : False
WriteThrough : False
Offline : False
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : False
Id : 06740ddcb6044087b413f4e34ed603b7
Caption : Virtual disk 1
ExtendedCaption : Virtual disk 1 from Ft. Lauderdale
Internal : False
     
VirtualDiskGroupId :
FirstHostId : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3
SecondHostId : 781D998D-3920-46BB-9F26-88BC591772B6
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
Alias : Virtual disk 3
Description :
Size : 10.00 GB
Type : MultiPathMirrored
DiskStatus : Online
InquiryData : DataCore Virtual Disk DCS
ScsiDeviceId : {96, 3, 13, 144...}
RemovableMedia : False
WriteThrough : False
Offline : False
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : False
Id : d2cc2a26ff5c4b0b99736f10bdd863ec
Caption : Virtual disk 3
ExtendedCaption : Virtual disk 3 from Ft. Lauderdale
Internal : False
     
VirtualDiskGroupId :
FirstHostId : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3
SecondHostId : 781D998D-3920-46BB-9F26-88BC591772B6
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
Alias : Virtual disk 4
Description :
Size : 10.00 GB
Type : MultiPathMirrored
DiskStatus : Online
InquiryData : DataCore Virtual Disk DCS
ScsiDeviceId : {96, 3, 13, 144...}
RemovableMedia : False
WriteThrough : False
Offline : False
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : False
Id : 9fcd72658c2d4023a7b239195b082326
Caption : Virtual disk 4
ExtendedCaption : Virtual disk 4 from Ft. Lauderdale
Internal : False
     

-------------- Example 2 Enables Continuous Data Protection on a virtual disk specified by name (caption) --------------

Enable-DcsDataProtection -Server SSV1 -VirtualDisk "Virtual disk 1" -Pool "Disk pool 1" -HistorySize 10GB

Continuous Data Protection is enabled for the virtual disk named "Virtual disk 1". The history log is created on the disk pool "Disk pool 1" on server "SSV1". The history log will be using the a maximum size of 10GB.

VirtualDiskGroupId :
FirstHostId : 8BFC6F8B-F0F3-48D9-AE9A-635BC66557C4
SecondHostId : C2CAEE8A-8D1E-4165-96D4-4EFB4FC067C4
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
SnapshotPoolId :
Alias : Virtual disk 1
Description :
Size : 20 GB
Type : MultiPathMirrored
DiskStatus : Online
InquiryData : DataCore Virtual Disk DCS c7995948602c4a67b6dd0126a2b9b856
ScsiDeviceId : {96, 3, 13, 144...}
ScsiDeviceIdString : 60030D9079E2A103A08E76ABBCBE1BF3
RemovableMedia : False
WriteThrough : False
Offline : False
Disabled : False
ManualRecovery : False
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : True
SequenceNumber : 16362
Id : c7995948602c4a67b6dd0126a2b9b856
Caption : Virtual disk 1
ExtendedCaption : Virtual disk 1 from ServerGroup1
Internal : False
     

-------------- Example 3 Enables Continuous Data Protection for a virtual disk group --------------

Enable-DcsDataProtection -VirtualDiskGroup VDGroup1 -Server SSVVM1 -Pool "Disk pool 1"

Enables Continuous Data Protection for the virtual group named "VDGroup1" and the history log will be created from the pool named "Disk pool 1" on the server SSVVM1.

Alias : VDGroup1
Description :
Id : {993a4a47-d76f-4ca4-83a1-8669d436e198}
Caption : VDGroup1
ExtendedCaption : VDGroup1
Internal : False
     

To Table of Contents

NAME

Enable-DcsReplicationTestMode

SYNOPSIS

Enables replication test mode for a local standby virtual disk.

SYNTAX

Enable-DcsReplicationTestMode   -Replication <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Enable-DcsReplicationTestMode   -VirtualDiskGroup <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Enables replication test mode for a local standby virtual disk. Test mode temporarily activates the standby (destination) virtual disk which temporarily enables all host paths on the standby side. In test mode, users can ensure that paths are correctly configured and hosts have read/write access to the virtual disk. Warning: Test mode can take a considerable amount of time, uses storage allocation overhead, and can affect performance. Do not enable test mode during a disaster. Disable test mode when testing is complete, see Disable-DcsReplicationTestMode. Data changes on the standby virtual disk made during test mode are temporary and will be deleted when test mode is disabled.

PARAMETERS

-Replication<Object>
AsyncReplicationData object, VirtualDiskData object, Async Replication ID, virtual disk name, or virtual disk ID that identifies the standby (destination) virtual disk in the replication. The standby virtual disk must be in the local server group. The AsyncReplicationData object can be obtained from Get-DcsReplication.

Required: true
Position: 1
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-VirtualDiskGroup<Object>
VirtualDiskGroupData object, name or ID that identifies a virtual disk group. Use this parameter to enable test mode for all eligible virtual disks in the virtual disk group. Eligibility may not apply to all virtual disks in the group. The VirtualDiskGroupData object can be obtained with Get-DcsVirtualDiskGroup.

Required: true
Position: 1
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

AsyncReplicationData or VirtualDiskData : Object that identifies the standby virtual disk in a replication.

OUTPUTS

AsyncReplicationData : Object that identifies and describes the relationship between the Active (source) and standby (destination) virtual disks in the replication.

NOTES

Also see Disable-DcsReplicationTestMode.

EXAMPLES

-------------- Example 1 Enables test mode on a virtual disk specified by name --------------

Enable-DcsReplicationTestMode -Replication RepVD1

Test mode is enabled on the standby virtual disk named "RepVD1" in the local server group.

FirstServerId : D3D14D3A-67A2-4E5F-9FA4-262B812EFFA0
FirstVirtualDiskId : a407b0413f9348a2bf645a14d9cf7c57
SecondServerId : a6c68fe8-ea6f-420f-b791-278a02a176eb:AA56BE97-83F3-45B0-B81C-2184A8083E68
SecondVirtualDiskId : d3a0fbdd7eae488a936cea47d31ddfd9
IsActiveSide : False
ReplicationState : Standby
FailureStatus : NoFailure
TransferStatus : Enabled
Paused : False
CheckpointSnapshotId :
AutoAsyncReplicationLicense : Enabled
OfflineInitializationSupported : True
InitializationType : Online
OfflineInitializationBuffer :
OfflineInitStatus : NoOfflineInit
InitializationFailureStatus : NoFailure
TestModeStatus : Active
Id : 3e017326-4f28-417e-bbd2-6dd238743902
Caption : RepVD1
ExtendedCaption : RepVD1 on SSVVM3
Internal : False
     

-------------- Example 2 Enables test mode on all standby virtual disks --------------

Get-DcsReplication -ShowOnlyLocalSide | Enable-DcsReplicationTestMode

The cmdlet Get-DcsReplication is invoked on the destination (standby) partner to obtain AsyncReplicationData objects for all local standby virtual disks. Those objects are piped to Enable-DcsReplicationTestMode to enable test mode for those virtual disks in the local server group.

FirstServerId : D3D14D3A-67A2-4E5F-9FA4-262B812EFFA0
FirstVirtualDiskId : a407b0413f9348a2bf645a14d9cf7c57
SecondServerId : a6c68fe8-ea6f-420f-b791-278a02a176eb:AA56BE97-83F3-45B0-B81C-2184A8083E68
SecondVirtualDiskId : d3a0fbdd7eae488a936cea47d31ddfd9
IsActiveSide : False
ReplicationState : Standby
FailureStatus : Offline
TransferStatus : Unknown
Paused : False
CheckpointSnapshotId :
AutoAsyncReplicationLicense : Enabled
OfflineInitializationSupported : True
InitializationType : Online
OfflineInitializationBuffer :
OfflineInitStatus : NoOfflineInit
InitializationFailureStatus : NoFailure
TestModeStatus : Active
Id : 3e017326-4f28-417e-bbd2-6dd238743902
Caption : Virtual disk 1
ExtendedCaption : Virtual disk 1 on SSVVM3
Internal : False
     
FirstServerId : D3D14D3A-67A2-4E5F-9FA4-262B812EFFA0
FirstVirtualDiskId : 656bb58c14af4e60ac42daf3db74eacd
SecondServerId : a6c68fe8-ea6f-420f-b791-278a02a176eb:AA56BE97-83F3-45B0-B81C-2184A8083E68
SecondVirtualDiskId : 537cd02923d7487bb8371da08d5bcf8e
IsActiveSide : False
ReplicationState : Standby
FailureStatus : Offline
TransferStatus : Unknown
Paused : False
CheckpointSnapshotId :
AutoAsyncReplicationLicense : Enabled
OfflineInitializationSupported : True
InitializationType : Online
OfflineInitializationBuffer :
OfflineInitStatus : NoOfflineInit
InitializationFailureStatus : NoFailure
TestModeStatus : Active
Id : b48a5f68-9861-4948-b902-0ad1dae78e43
Caption : Virtual disk 2
ExtendedCaption : Virtual disk 2 on SSVVM3
Internal : False
     

To Table of Contents

NAME

Enable-DcsSequentialStorage

SYNOPSIS

Enables the sequential storage setting for a virtual disk or members in a virtual disk group.

SYNTAX

Enable-DcsSequentialStorage   -VirtualDisk <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Enable-DcsSequentialStorage   -VirtualDiskGroup <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Enables the sequential storage setting for a virtual disk or members in a virtual disk group. NOTE: In order to enable this feature at the group level, all group members must be eligible for sequential storage and not already be enabled; otherwise, members must be enabled individually.

PARAMETERS

-VirtualDisk<Object>
VirtualDiskData object, name, or ID that identifies the virtual disk.

Required: true
Position: 1
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-VirtualDiskGroup<Object>
VirtualDiskGroupData object, name or ID that identifies a virtual disk group. Use this parameter to enable sequential storage for all eligible virtual disks in the virtual disk group. The VirtualDiskGroupData object can be obtained with Get-DcsVirtualDiskGroup.

Required: true
Position: 2
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

VirtualDiskData : Object that identifies and describes the virtual disk.

OUTPUTS

VirtualDiskData or VirtualDiskGroupData : Object that identifies and describes the virtual disk or virtual disk group.

NOTES

Also see Disable-DcsSequentialStorage, Get-DcsVirtualDisk, Get-DcsVirtualDiskGroup

EXAMPLES

-------------- Example 1 Enables sequential storage for a specified virtual disk --------------

Enable-DcsSequentialStorage -VirtualDisk "Virtual disk 1"

The sequential storage setting is enabled for the virtual disk named "Virtual disk 1".

VirtualDiskGroupId :
FirstHostId : BB3877BA-4FC9-4429-8D1F-D57D23808ED6
SecondHostId : D4DB7B7A-67F5-4ECB-8350-166057170F7D
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
SnapshotPoolId :
Alias : Virtual disk 1
Description :
Size : 20 GB
Type : MultiPathMirrored
DiskStatus : Online
InquiryData : DataCore Virtual Disk DCS dc1df97ee1454f3482a54c456ebc209a
ScsiDeviceId : {96, 3, 13, 144...}
ScsiDeviceIdString : 60030D90B5F1CE06C7E2F4F65FE4CE85
RemovableMedia : False
WriteThrough : False
Offline : False
Disabled : False
ManualRecovery : False
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : False
SequenceNumber : 3194
Id : dc1df97ee1454f3482a54c456ebc209a
Caption : Virtual disk 1
ExtendedCaption : Virtual disk 1 from Group1
Internal : False
     

-------------- Example 2 Enables sequential storage for virtual disks in a group --------------

Enable-DcsSequentialStorage -VirtualDiskGroup "VD Group 1"

The sequential storage setting is enabled for the eligible virtual disks in the group named "VD Group 1". The object VirtualDiskGroupData is returned.

TotalCapacity : 40 GB
Alias : VD Group 1
Description :
SequenceNumber : 3357
Id : {c76830b5-5f1d-4991-97a5-4c0961f0096a}
Caption : VD Group 1
ExtendedCaption : VD Group 1
Internal : False
     

To Table of Contents

NAME

Enable-DcsServerWriteCache

SYNOPSIS

Enables write caching for the specified server.

SYNTAX

Enable-DcsServerWriteCache   -Server <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Enables write caching for the specified server. When enabled, all write operations from client hosts will be acknowledged and then written to the back-end storage.

PARAMETERS

-Server<Object>
ServerHostData object, computer name, or ID that identifies the server. The computer name must be unique or the name must be fully qualified.

Required: true
Position: 1
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias representing the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

ServerHostData : Object that identifies and describes the server.

OUTPUTS

ServerHostData : Object that identifies and describes the server.

NOTES

Also see Disable-DcsServerWriteCache.

EXAMPLES

-------------- Example 1 Enables write caching on a server specified by name (caption) --------------

Enable-DcsServerWriteCache -Server SSV1

Enables write caching on the server named "SSV1".

GroupId : 626ad5ae-8297-4068-832c-7c476fe32abf
RegionNodeId : ExecutiveNode:A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3
CacheSize : 0.00 B
State : Online
SupportState : Idle
SnapshotMapStoreId :
SnapshotMapStorePoolId :
InstallPath : C:\Program Files\DataCore\SANsymphony
ProductName : DataCore SANsymphony
ProductType : Standard
ProductVersion : 8.1
OsVersion : Windows Server 2008 R2 x64 Edition, Service Pack 1
ProcessorInfo : DataCore.Executive.ProcessorInformation
ProductBuild : 13.1.0.798
BuildType : Release
DiagnosticMode : Enabled
LicenseRemaining : 22374000000000
ReplicationBufferFolder :
TotalSystemMemory : 1,023.56 MB
AvailableSystemMemory : 46.37 MB
LogStatus : Operational
LicenseSettings : DataCore.Executive.LicenseSettings
IsLicensed : True
StorageUsed : 0.00 B
PowerState : ACOnline
CacheState : WritebackGlobal
BackupStorageFolder : C:\Program Files\DataCore\SANsymphony\Backups\
IpAddresses : {172.20.17.63, fe80::ac9f:4abc:8e7:447a, 13.0.0.31, fe80::2de4:e3b4:87d0:b299...}
Description :
HostName : SSV1.datacoresoftware.com
Id : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3
Caption : SSV1
ExtendedCaption : SSV1 in Ft. Lauderdale
Internal : False
     

-------------- Example 2 Enables write caching on all servers in the server group by piping objects --------------

Get-DcsServer | Enable-DcsServerWriteCache

The cmdlet Get-DcsServer is used to obtain the server objects which are piped to Enable-DcsServerWriteCache resulting in write caching being enabled on both servers (SSV1 and SSV2) in the server group.

GroupId : 626ad5ae-8297-4068-832c-7c476fe32abf
RegionNodeId : ExecutiveNode:A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3
CacheSize : 0.00 B
State : Online
SupportState : Idle
SnapshotMapStoreId :
SnapshotMapStorePoolId :
InstallPath : C:\Program Files\DataCore\SANsymphony
ProductName : DataCore SANsymphony
ProductType : Standard
ProductVersion : 8.1
OsVersion : Windows Server 2008 R2 x64 Edition, Service Pack 1
ProcessorInfo : DataCore.Executive.ProcessorInformation
ProductBuild : 13.1.0.798
BuildType : Release
DiagnosticMode : Enabled
LicenseRemaining : 22374000000000
ReplicationBufferFolder :
TotalSystemMemory : 1,023.56 MB
AvailableSystemMemory : 45.64 MB
LogStatus : Operational
LicenseSettings : DataCore.Executive.LicenseSettings
IsLicensed : True
StorageUsed : 0.00 B
PowerState : ACOnline
CacheState : WritebackGlobal
BackupStorageFolder : C:\Program Files\DataCore\SANsymphony\Backups\
IpAddresses : {172.20.17.63, fe80::ac9f:4abc:8e7:447a, 13.0.0.31, fe80::2de4:e3b4:87d0:b299...}
Description :
HostName : SSV1.datacoresoftware.com
Id : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3
Caption : SSV1
ExtendedCaption : SSV1 in Ft. Lauderdale
Internal : False
     
GroupId : 626ad5ae-8297-4068-832c-7c476fe32abf
RegionNodeId : ExecutiveNode:781D998D-3920-46BB-9F26-88BC591772B6
CacheSize : 0.00 B
State : Online
SupportState : Idle
SnapshotMapStoreId :
SnapshotMapStorePoolId :
InstallPath : C:\Program Files\DataCore\SANsymphony
ProductName : DataCore SANsymphony
ProductType : Standard
ProductVersion : 8.1
OsVersion : Windows Server 2008 R2 x64 Edition, Service Pack 1
ProcessorInfo : DataCore.Executive.ProcessorInformation
ProductBuild : 13.1.0.798
BuildType : Release
DiagnosticMode : Enabled
LicenseRemaining : 22410000000000
ReplicationBufferFolder :
TotalSystemMemory : 1,023.56 MB
AvailableSystemMemory : 247.05 MB
LogStatus : Operational
LicenseSettings : DataCore.Executive.LicenseSettings
IsLicensed : True
StorageUsed : 0.00 B
PowerState : ACOnline
CacheState : WritebackGlobal
BackupStorageFolder : C:\Program Files\DataCore\SANsymphony\Backups\
IpAddresses : {172.20.17.157, fe80::2920:ddc6:93a7:45df, 13.0.0.35, fe80::6181:9311:6644:c8d2...}
Description :
HostName : SSV2.datacoresoftware.com
Id : 781D998D-3920-46BB-9F26-88BC591772B6
Caption : SSV2
ExtendedCaption : SSV2 in Ft. Lauderdale
Internal : False
     

To Table of Contents

NAME

Enable-DcsTask

SYNOPSIS

Enables a task, which allows the task to run.

SYNTAX

Enable-DcsTask   -Task <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Enables a task, which allows the task to run.

PARAMETERS

-Task<Object>
TaskData object, name, or ID that identifies the task.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

TaskData : Object the identifies and describes the task.

OUTPUTS

TasKData : Object the identifies and describes the task.

NOTES

Also see Get-DcsTask, Set-DcsTaskProperties, Add-DcsTask, Disable-DcsTask.

EXAMPLES

-------------- Example 1 Enables a task specified by name (caption) --------------

Enable-DcsTask -Task MyNightlyTask

Enable the task named "MyNightlyTask", allowing it to run.

Description : Start Virtual Disk Reclamation at 2 am
Enabled : True
ActionBehavior : RunPerTrigger
MaxRunTime : 6048000000000
Connective : LogicalAnd
ActionDelay : 0
State : Idle
CurrentActionId :
LastStartTime : 1/1/0001 12:00:00 AM
LastStopTime : 1/1/0001 12:00:00 AM
Id : e0b61456-55b1-4f09-9567-39586e71ef16
Caption : MyNightlyTask
ExtendedCaption : MyNightlyTask
Internal : False
     

-------------- Example 2 Enables all tasks by piping objects --------------

Get-DcsTask | Enable-DcsTask

The task objects are obtained using the Get-DcsTask cmdlet and piped to Enable-DcsTask, resulting in all disabled tasks on all servers in the server group being enabled.

Description :
Enabled : True
ActionBehavior : RunPerTrigger
MaxRunTime : 6048000000000
Connective : LogicalOr
ActionDelay : 0
State : Idle
CurrentActionId :
LastStartTime : 1/1/0001 12:00:00 AM
LastStopTime : 1/1/0001 12:00:00 AM
Id : 32651f76-72e9-4852-ba35-0b111eaa7808
Caption : Task 1
ExtendedCaption : Task 1
Internal : False
     
Description :
Enabled : True
ActionBehavior : RunPerTrigger
MaxRunTime : 6048000000000
Connective : LogicalOr
ActionDelay : 0
State : Idle
CurrentActionId :
LastStartTime : 1/1/0001 12:00:00 AM
LastStopTime : 1/1/0001 12:00:00 AM
Id : b72c3fac-61d0-4641-95f1-1c310b7c322d
Caption : Task 2
ExtendedCaption : Task 2
Internal : False
     

To Table of Contents

NAME

Enable-DcsVirtualDiskAutoRecovery

SYNOPSIS

Enables automatic mirror recovery for a virtual disk or virtual disk group.

SYNTAX

Enable-DcsVirtualDiskAutoRecovery   -VirtualDisk <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]   [ -WhatIf]   [ -Confirm]

Enable-DcsVirtualDiskAutoRecovery   -VirtualDiskGroup <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]   [ -WhatIf]   [ -Confirm]

DESCRIPTION

Enables automatic mirror recovery for a virtual disk or virtual disk group. By default, auto-recovery is enabled. Use this cmdlet to enable auto-recovery after it has been disabled, see Disable-DcsVirtualDiskAutoRecovery.

PARAMETERS

-VirtualDisk<Object>
VirtualDiskData object, name, or ID that identifies the virtual disk.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-WhatIf<SwitchParameter>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Confirm<SwitchParameter>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-VirtualDiskGroup<Object>
VirtualDiskGroupData object, name or ID that identifies a virtual disk group. When the operation is performed on a virtual disk group, auto-recovery will be enabled for all eligible virtual disks in the group and the rest will be ignored.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

VirtualDiskData : Object that identifies and describes a virtual disk.

OUTPUTS

NOTES

Also see Disable-DcsVirtualDiskAutoRecovery, Get-DcsVirtualDisk, Get-DcsVirtualDiskGroup, Resume-DcsVirtualDiskRecovery, Pause-DcsVirtualDiskRecovery.

EXAMPLES

-------------- Example 1 Enables auto recovery for all virtual disks on a specified server --------------

Get-DcsVirtualDisk -Server SSV1 | Enable-DcsVirtualDiskAutoRecovery

The cmdlet Get-DcsVirtualDisk is invoked to get VirtualDiskData objects for all virtual disks on the server named "SSV1." The results are piped to the cmdlet Enable-DcsVirtualDiskAutoRecovery to enable auto-recovery for all eligible virtual disks. A VirtualDiskData object is returned for each virtual disk that has been enabled.

VirtualDiskGroupId :
FirstHostId : E9D5564F-D72A-4C5C-AA0F-B2C23A3AD093
SecondHostId : BBA07A42-44F1-40A6-A0E0-756351FFE386
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
SnapshotPoolId :
Alias : Virtual disk 1
Description :
Size : 50.00 GB
Type : MultiPathMirrored
DiskStatus : Online
InquiryData : DataCore Virtual Disk DCS ec6a87754077499dbe1eda213c6df2e0
ScsiDeviceId : {96, 3, 13, 144...}
ScsiDeviceIdString : 60030D90446DFE01504F9B5BE7187E6F
RemovableMedia : False
WriteThrough : False
Offline : False
Disabled : False
ManualRecovery : False
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : True
SequenceNumber : 35320
Id : ec6a87754077499dbe1eda213c6df2e0
Caption : Virtual disk 1
ExtendedCaption : Virtual disk 1 from Group1
Internal : False
     
VirtualDiskGroupId :
FirstHostId : E9D5564F-D72A-4C5C-AA0F-B2C23A3AD093
SecondHostId : BBA07A42-44F1-40A6-A0E0-756351FFE386
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
SnapshotPoolId :
Alias : Virtual disk 4
Description :
Size : 45.00 GB
Type : MultiPathMirrored
DiskStatus : Online
InquiryData : DataCore Virtual Disk DCS c342896abdbb4de9ba009e9ee63fa815
ScsiDeviceId : {96, 3, 13, 144...}
ScsiDeviceIdString : 60030D903E7D6C078ED2765BEE1ADBCA
RemovableMedia : False
WriteThrough : False
Offline : False
Disabled : False
ManualRecovery : False
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : True
SequenceNumber : 35322
Id : c342896abdbb4de9ba009e9ee63fa815
Caption : Virtual disk 4
ExtendedCaption : Virtual disk 4 from Group1
Internal : False
     
VirtualDiskGroupId :
FirstHostId : E9D5564F-D72A-4C5C-AA0F-B2C23A3AD093
SecondHostId : BBA07A42-44F1-40A6-A0E0-756351FFE386
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
SnapshotPoolId :
Alias : Virtual disk 6
Description :
Size : 10.00 GB
Type : MultiPathMirrored
DiskStatus : Online
InquiryData : DataCore Virtual Disk DCS 26599ea3d8704c668b0c6ee048c00653
ScsiDeviceId : {96, 3, 13, 144...}
ScsiDeviceIdString : 60030D90E6876C07DBC76ADE1851A94A
RemovableMedia : False
WriteThrough : False
Offline : False
Disabled : False
ManualRecovery : False
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : True
SequenceNumber : 35324
Id : 26599ea3d8704c668b0c6ee048c00653
Caption : Virtual disk 6
ExtendedCaption : Virtual disk 6 from Group1
Internal : False
     
VirtualDiskGroupId : {94add581-0054-4317-95c7-f6f81309370b}
FirstHostId : E9D5564F-D72A-4C5C-AA0F-B2C23A3AD093
SecondHostId : BBA07A42-44F1-40A6-A0E0-756351FFE386
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
SnapshotPoolId :
Alias : Virtual disk 2
Description :
Size : 10.00 GB
Type : MultiPathMirrored
DiskStatus : Online
InquiryData : DataCore Virtual Disk DCS a55059113f1e424895f4eea7751aa546
ScsiDeviceId : {96, 3, 13, 144...}
ScsiDeviceIdString : 60030D906348F000688BBA02259ABAE1
RemovableMedia : False
WriteThrough : False
Offline : False
Disabled : False
ManualRecovery : False
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : False
SequenceNumber : 35326
Id : a55059113f1e424895f4eea7751aa546
Caption : Virtual disk 2
ExtendedCaption : Virtual disk 2 from Group1
Internal : False
     

-------------- Example 2 Enables auto recovery for all eligible virtual disks in all virtual disk groups --------------

$VDGroup = Get-DcsVirtualDiskGroup
$VDGroup | ForEach { Enable-DcsVirtualDiskAutoRecovery -VirtualDiskGroup $_.Id }

The cmdlet Get-DcsVirtualDiskGroup is invoked without parameters to get the VirtualDiskGroupData objects for the local server group. The objects are stored in the variable $VDGroup. The IDs in each object in $VDGroup are used to identify the virtual disk groups in the server group. The ForEach loop is used to perform the operation for each object in $VDGroup. Auto-recovery is enabled for all eligible virtual disks in all virtual disk groups in the local server group. A VirtualDiskData object is returned for each virtual disk that has been enabled.

VirtualDiskGroupId : {94add581-0054-4317-95c7-f6f81309370b}
FirstHostId : E9D5564F-D72A-4C5C-AA0F-B2C23A3AD093
SecondHostId : BBA07A42-44F1-40A6-A0E0-756351FFE386
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
SnapshotPoolId :
Alias : Virtual disk 2
Description :
Size : 10.00 GB
Type : MultiPathMirrored
DiskStatus : Online
InquiryData : DataCore Virtual Disk DCS a55059113f1e424895f4eea7751aa546
ScsiDeviceId : {96, 3, 13, 144...}
ScsiDeviceIdString : 60030D906348F000688BBA02259ABAE1
RemovableMedia : False
WriteThrough : False
Offline : False
Disabled : False
ManualRecovery : False
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : False
SequenceNumber : 43554
Id : a55059113f1e424895f4eea7751aa546
Caption : Virtual disk 2
ExtendedCaption : Virtual disk 2 from Group1
Internal : False
     
VirtualDiskGroupId : {94add581-0054-4317-95c7-f6f81309370b}
FirstHostId : E9D5564F-D72A-4C5C-AA0F-B2C23A3AD093
SecondHostId : BBA07A42-44F1-40A6-A0E0-756351FFE386
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
SnapshotPoolId :
Alias : Virtual disk 5
Description :
Size : 20.00 GB
Type : MultiPathMirrored
DiskStatus : Online
InquiryData : DataCore Virtual Disk DCS 3dfbb8a237f5423eb5c0552cd8519807
ScsiDeviceId : {96, 3, 13, 144...}
ScsiDeviceIdString : 60030D907FB2DF01D442CE4F03FBAD4F
RemovableMedia : False
WriteThrough : False
Offline : False
Disabled : False
ManualRecovery : False
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : False
SequenceNumber : 43556
Id : 3dfbb8a237f5423eb5c0552cd8519807
Caption : Virtual disk 5
ExtendedCaption : Virtual disk 5 from Group1
Internal : False
     
VirtualDiskGroupId : {922682bc-0651-4bfc-9eef-296e078ffa01}
FirstHostId : E9D5564F-D72A-4C5C-AA0F-B2C23A3AD093
SecondHostId : BBA07A42-44F1-40A6-A0E0-756351FFE386
BackupHostId :
StorageProfileId : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
SnapshotPoolId :
Alias : Virtual disk 7
Description :
Size : 20.00 GB
Type : MultiPathMirrored
DiskStatus : Online
InquiryData : DataCore Virtual Disk DCS 213c79d72bb84082a9e90872e332adeb
ScsiDeviceId : {96, 3, 13, 144...}
ScsiDeviceIdString : 60030D90D42CFC01912D9A713C04BEBF
RemovableMedia : False
WriteThrough : False
Offline : False
Disabled : False
ManualRecovery : False
DiskLayout : DataCore.Executive.PhysicalDiskLayout
PersistentReserveEnabled : True
RecoveryPriority : Regular
IsServed : False
SequenceNumber : 43558
Id : 213c79d72bb84082a9e90872e332adeb
Caption : Virtual disk 7
ExtendedCaption : Virtual disk 7 from Group1
Internal : False
     

To Table of Contents

NAME

Export-DcsObjectModel

SYNOPSIS

Saves the configuration states of all objects in the configuration to an xml file.

SYNTAX

Export-DcsObjectModel   -OutputDirectory <String>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Saves the configuration states of all objects in the server group configuration to an xml file. If the file path does not exist, it will be created. The file will be named DcsObjectModel with the date and time appended (for example DcsObjectModel_2011_07_29_20_19_25). This cmdlet is included as a diagnostic tool for DataCore Technical Support.

PARAMETERS

-OutputDirectory<String>
The complete path to the folder where the object model information should be saved. If the folder does not exist, it will be created. The file will be created on the default server for the specified connection. The path should begin with the drive letter. For instance, "C:\ObjectModel" could be a valid path.

Required: true
Position: 1
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: 2
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

xml file : Configuration states for all objects.

NOTES

EXAMPLES

-------------- Example 1 Exports configuration states --------------

Export-DcsObjectModel -OutputDirectory C:\ConfigStates

Saves the configuration states of all objects in the path "C:\ConfigStates". The folder did not exist and was created when the cmdlet was invoked.

C:\ConfigStates
                                

To Table of Contents

NAME

Export-DcsReport

SYNOPSIS

Creates a report which can be exported in a variety of formats.

SYNTAX

Export-DcsReport   -ReportName <String>   -ReportType <String>   -ExportType <String>   [ -ReportDescription <String> ]   [ -Server <String[]> ]   [ -Client <String[]> ]   [ -DiskPool <String[]> ]   [ -MappingType <String[]> ]   [ -VirtualDiskKind <String[]> ]   [ -PortType <String[]> ]   [ -MonitorState <String[]> ]   [ -HostGroup <String[]> ]   [ -VirtualDiskGroup <String[]> ]   [ -PhysicalDiskType <String[]> ]   [ -ExcludeNonServedDisk]   [ -SortBy <String> ]   [ -DescendingOrder]   [ -SaveToFile <String> ]   [ -OverrideFile]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Export-DcsReport   -ReportName <String>   -ReportType <String>   -ExportType <String>   [ -ReportDescription <String> ]   [ -Server <String[]> ]   [ -Client <String[]> ]   [ -DiskPool <String[]> ]   [ -MappingType <String[]> ]   [ -VirtualDiskKind <String[]> ]   [ -PortType <String[]> ]   [ -MonitorState <String[]> ]   [ -HostGroup <String[]> ]   [ -VirtualDiskGroup <String[]> ]   [ -PhysicalDiskType <String[]> ]   -StartTime <DateTime>   -EndTime <DateTime>   [ -ExcludeNonServedDisk]   [ -SortBy <String> ]   [ -DescendingOrder]   [ -SaveToFile <String> ]   [ -OverrideFile]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Creates a report which can be exported in a variety of formats. Filtering parameters may be specified to narrow the scope of the report data. If no parameters are specified, all data for the specified report will be included in the report. Sort order criteria may be specified and sorted by ascending or descending order. Also, the returned data object can be pipelined to another cmdlet or script.

PARAMETERS

-ReportName<String>
The name of the report.

Required: true
Position: 1
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-ReportType<String>
The type of report to export. Possible parameter values include "Data Usage", "Detailed Data Usage", "Disk Pools", "Hosts", "Hosts By Group", "Paths", "Paths By Host", "Paths By Host Port", "Paths By Server", "Paths By Server Port", "Paths By Virtual Disk", "Physical Disks", "Physical Storage By Server", "Port Connections", "Ports By Host", "Ports By Server", "System Health", "Virtual Disks", "Virtual Disks By Host", "Virtual Disks By Group", "Virtual Disks By Host Port", "Virtual Disks By Path", "Virtual Disks By Pool", "Virtual Disks By Server", or "Virtual Disks By Server Port".

Required: true
Position: 2
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-ExportType<String>
The format of the report. Possible parameter values include "Csv", "Html", "Mht", "Pdf", "Rtf", "Text", "Xls", "Xlsx", "Bmp", "Gif", "Jpeg" or "Png".

Required: true
Position: 3
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-ReportDescription<String>
Description of report.

Required: false
Position: 4
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Server<String[]>
Filtering parameter used to specify one or more servers. This filter applies to all reports except host reports, Ports By Host report, both Data Usage reports, and System Health report. Values can be the computer name or ID that identifies one or more servers. The computer names must be unique or the names must be fully qualified. If this parameter is specified, only data for those servers will be included in the report. If the parameter is not specified, data for all servers in the local server group will be included in the report.

Required: false
Position: 5
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Client<String[]>
Filtering parameter used to specify one or more clients (hosts). This filter applies to all virtual disks reports, and reports "By Host" or "By Host Port" (such as Paths By Host). Values can be the name or ID that identifies one or more clients. If this parameter is specified, only data for those clients will be included in the report. If the parameter is not specified, data for all clients in the local server group will be included in the report. See the parameter ExcludeNonServedDisk if required to exclude virtual disks that are not served to hosts.

Required: false
Position: 6
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-DiskPool<String[]>
Filtering parameter used to specify one or more disk pools. This filter applies to the Physical Storage By Server report and the Virtual Disks By Pool report. Values can be the name, or ID that identifies one or more disk pools. (To resolve by name, the name must be unique to the server group or the server must be specified.) If this parameter is specified, only data for those disk pools will be included in the report. If the parameter is not specified, data for all disk pools in the local server group will be included in the report.

Required: false
Position: 7
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-MappingType<String[]>
Filtering parameter used to specify one or more path roles. This filter applies to the following reports: Paths, Paths By Server, Paths By Server Port, Paths By Virtual Disk and Virtual Disks by Path. Valid values include "Client" (front-end path) and "Mirror". If this parameter is specified, only data for those path roles will be included in the report. If the parameter is not specified, data for all path roles will be included in the report.

Required: false
Position: 8
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-VirtualDiskKind<String[]>
Filtering parameter used to specify one or more kinds of virtual disks. This filter applies to all virtual disk reports. Valid values include "VirtualDisk", "Snapshot", and "Rollback". If this parameter is specified, only data for virtual disks of that kind will be included in the report. If the parameter is not specified, data for all virtual disks in the local server group will be included in the report.

Required: false
Position: 9
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PortType<String[]>
Filtering parameter used to specify one or more port types. This filter applies to all port reports. Valid values include "Fibre Channel", "iSCSI", and "Loopback". If this parameter is specified, only data for those port types will be included in the report. If the parameter is not specified, data for all ports will be included in the report.

Required: false
Position: 10
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-MonitorState<String[]>
Filtering parameter used to specify one or more System Health message categories. This filter applies to the System Health report. Valid values include "Attention", "Warning", and "Critical". If this parameter is specified, only System Health messages of those categories will be included in the report. If the parameter is not specified, data for all System Health messages in the local server group will be included in the report.

Required: false
Position: 11
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-HostGroup<String[]>
Filtering parameter used to specify host group names, supplied in an array of strings separated by commas, for example: "Host Group 1", "Host Group 2", "Host Group 3". A host group name "No Group" is also allowed. "No Group" will return all objects that are not part of a group. For example, if the argument is "No Group" for the Hosts by Group report, the report will include only hosts that do not belong to any host group. The HostGroup filter applies to the following reports: Data Usage, Detailed Data Usage, Hosts, Hosts by Group, Paths by Host, Paths by Host and Ports by Host. if this parameter is specified, only data for those host groups will be included in the report. If the parameter is not specified, data for all host groups in the local server group will be included in the report. For the Detailed Data Usage report, more than one host name is not supported and that one host group name is required.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-VirtualDiskGroup<String[]>
Filtering parameter used to specify one or more virtual disk group names, supplied in an array of strings separated by commas. A virtual disk group name "No Group" is also allowed. "No Group" will return all objects that are not part of a group. For example, if the argument is "No Group" for the Virtual Disk report, the report will include only virtual disks that do not belong to any virtual disk group. This filter applies to the following reports: Paths, Paths By Server, Paths By Server Port, Paths By Virtual Disk, and all virtual disk reports. If this parameter is specified, only data for those virtual disk groups will be included in the report. If the parameter is not specified, data for all virtual disk groups in the local server group will be included in the report.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PhysicalDiskType<String[]>
Filtering parameter used to specify one or more physical disk types. This filter applies to the following reports: Physical Disks and Physical Storage By Server. Valid values include "Available", "PassThrough", and "Pool". If this parameter is specified, only data for those physical disk types will be included in the report. If the parameter is not specified, data for all physical disk types will be included in the report.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-ExcludeNonServedDisk<SwitchParameter>
Specify this switch parameter to exclude virtual disks that are not served in the report data, for instance when filtering by hosts or host groups when unserved virtual disks may not apply. This parameter applies to all virtual disk reports except Virtual Disks By Host and Virtual Disks By Host Port reports.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-SortBy<String>
Sort order criteria. Specify this parameter to sort the report by the designated value. For Data Usage report, possible values include "HostGroupName", "TotalBytesTransferred", "TotalBytesWritten", "TotalBytesRead", "TotalOperations", "TotalWrites", or "TotalReads". (No sorting for Detailed Data Usage report.) For Disk Pools report, possible values include "ServerName", "PoolName", "PoolSize", or "PoolStatus". For Hosts and Hosts By Group reports, possible values include "HostName", "HostState", "PreferredServer", "Multipath", or "Alua". For Paths report, possible values include "InitiatorPort", "InitiatorMachine", "TargetPort", "TargetMachine", or "VirtualDisk". For Paths By Host and Paths by Host Port reports, possible values include "InitiatorPort", "TargetPort", "TargetMachine", or "VirtualDisk". For Paths By Server report, possible values include "TargetPort", "InitiatorPort", "InitiatorMachine", or "VirtualDisk". For Paths By Server Port report, possible values include "InitiatorPort", "InitiatorMachine", or "VirtualDisk". For Paths By Virtual Disk report, possible values include "InitiatorPort", "InitiatorMachine", "TargetPort", or "TargetMachine". For Physical Disks report, possible values include "ServerName", "DiskName", "DiskType", or "DiskStatus". For Physical Storage By Server report, possible values include "TierNumber", "DiskName", "DiskStatus", or "DiskSize". For Port Connections report, possible values include "PortAlias", "PortRole", "PortType", "PortStatus", or "PortMode". For Ports By Host report, possible values include "PortAlias", "PortName", "PortType", or "PortStatus". For Ports By Server report, possible values include "PortAlias", "PortName", "PortType", "PortStatus", PortRole", or ServerName". For System Health report, possible values include "ResourceName", "ResourceLastUpdate", or "ResourceStatus". For all virtual disks reports, possible values include "VirtualDiskName", "VirtualDiskType", "StorageProfile", "VirtualDiskStatus", or "ReplicationStatus".

Required: false
Position: 12
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-DescendingOrder<SwitchParameter>
Specify this parameter to sort the report in descending order. If this parameter is not specified, the report will be sorted in ascending order.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-SaveToFile<String>
Saves the report data to a file on the machine of the type specified in ReportType parameter. The file will be saved on the computer that invokes this cmdlet. Specify a complete path to an existing directory and the file name for the file. For example, if the report type is text and the value for this parameter is "C:\Reports\TextReport", then the report named "TextReport.txt" will be created in the C:\Reports directory. If the directory does not exist, it will not be created and result in an error, see the OverrideFile parameter for more information. If a file name is not entered in the provided path, the report name will be used as the file name. If a directory is not entered in the provided path, the file will be saved to the current PowerShell directory. If an empty string ("") is entered, the file will be saved in the current PowerShell directory and the name will be the report name. If this parameter is not specified, the report will be exported to the returned memory stream object and the object can be assigned to a variable in a script in order to use the results.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-OverrideFile<SwitchParameter>
This switch parameter is used in conjunction with the SaveToFile parameter. If there already exists a report of the same name in the same path as specified by the SaveToFile parameter, the OverrideFile parameter will cause the existing file to be overwritten and replaced with the new file and prevent an error from occurring.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-StartTime<DateTime>
Filtering parameter used to signify the beginning date and time of the data to provide in the report. The StartTime parameter is used with the EndTime parameter to provide a time interval or date range. These parameters are used with the Data Usage and Detailed Data Usage reports. One way to provide the StartTime parameter would be by passing a variable created by invoking New-Object with the TypeName parameter of DateTime with the correct arguments (see the Help for New-Object, Get-Date). The StartTime parameter can also be provided in a string that represents the date. An example of the format to use is "09/01/2014" which represents September 1, 2014. This value must be in quotes.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-EndTime<DateTime>
Filtering parameter used to signify the ending date and time of the data to provide in the report. The StartTime parameter is used with the EndTime parameter to provide a time interval or date range. Data for the End date will be included in the report. These parameters are used with the Data Usage and Detailed Data Usage reports. One way to provide the EndTime parameter would be by passing a variable created by invoking New-Object with the TypeName parameter of DateTime with the correct arguments (see the Help for New-Object, Get-Date). The EndTime parameter can also be provided in a string representing the date. An example of the format to use is "09/30/2014" which represents September 30, 2014. This value must be in quotes.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

System.IO.Stream : Memory stream object that contains the report data.

NOTES

EXAMPLES

-------------- Example 1 Exports a report in PDF and saves to a file. --------------

Export-DcsReport -ReportName "Virtual Disks By Server for SSVVM2" -ReportType "Virtual Disks By Server Port" -ExportType pdf -SaveToFile "C:\Reports\VD_BY_Svr_SSVVM2" -Server SSVVM2

A report of type "Virtual Disks By Server Port" named "Virtual Disks By Server for SSVVM2" is created on the computer invoking the cmdlet and exported in PDF to the existing folder "C:\Reports". The file is named "VD_BY_Svr_SSVVM2" and the report data will be contained in that file. The report is filtered by server named "SSVVM2" and only contains data for that server. The System.IO.Stream object is returned.

CanRead : True
CanSeek : True
CanWrite : True
Capacity : 99434
Length : 83107
Position : 0
CanTimeout : False
ReadTimeout :
WriteTimeout :
     

-------------- Example 2 Creates a virtual disk by group report and exports to a text file --------------

Export-DcsReport -ReportName "Virtual Disks Served to HostVM1" -ReportType "Virtual Disks By Group" -Export
Type text -SaveToFile "C:\Reports\VDs Served to HostVM1" -Client HostVM1 -VirtualDiskKind "VirtualDisk" -ExcludeNonServedDisk

A report of type "Virtual Disks By Group" named "Virtual Disks Served to HostVM1 is created on the computer invoking the cmdlet and exported in a text file to the existing folder "C:\Reports". The file is named "VDs Served to HostVM1" and the report data will be contained in that file. The report contains virtual disks in the local server group and is filtered to return only the regular virtual disks (not snapshots or rollbacks) that are served to the client named "HostVM1". The System.IO.Stream object is returned.

CanRead : True
CanSeek : True
CanWrite : True
Capacity : 4096
Length : 3978
Position : 0
CanTimeout : False
ReadTimeout :
WriteTimeout :
     

-------------- Example 3 Creates a detailed data usage report for a specified host group for the month of September --------------

Export-DcsReport -ReportName "Detailed Data Usage for September" -ReportType "Detailed Data Usage" -ExportType csv -SaveToFile "C:\Reports\DetailedDataUsageHostGroup1Sept" -OverrideFile -HostGroup "Host Group 1" -StartTime "09/01/2014" -EndTime "09/30/2014"

A report of type "Detailed Data Usage" named "Detailed Data Usage for Host Group 1 in September" is created on the computer invoking the cmdlet and exported in the report type "csv" (comma separated values) to the existing folder "C:\Reports". The file is named "DetailedDataUsageHostGroup1Sept" and the report data will be stored in that file. The parameter Override is included, so if a file with the same name and path exists, it will be replaced with the new file. The report contains I/O statistics used to charge back the customer affiliated with the host group "Host Group 1" that occurred between September 1, 2014 and September 30, 2014. The System.IO.Stream object is returned.

CanSeek : True
CanWrite : True
Capacity : 65536
Length : 36460
Position : 0
CanTimeout : False
ReadTimeout :
WriteTimeout :
     

-------------- Example 4 Creates a physical disks report and creates the report from the returned object --------------

$AvailableDisks = Export-DcsReport -ReportName "Available Physical Disks" -ReportType "Physical Disks" -ExportType csv -Server SSV1 -PhysicalDiskType Available
$DestinationStream = [System.IO.File]::Create("C:\Reports\"Available Physical Disks.csv")
$AvailableDisks.CopyTo($DestinationStream)
$DestinationStream.Flush()
$DestinationStream.Close()

A report of type "Physical Disks" named "Available Physical Disks" is created on the computer invoking the cmdlet and exported in the report type "csv" (comma separated values) to the existing folder "C:\Reports". The file is named "Physical Disks SSV1" and the report data will be contained in that file. The report contains the physical disks on the server "SSV1" that are currently available. The returned object System.IO.Stream is assigned to the variable $AvailableDisks. A file is created and the data in $AvailableDisks is copied to the variable $DestinationStream. The destination stream is flushed and closed.


To Table of Contents

NAME

Force-DcsVirtualDiskOnline

SYNOPSIS

Forces a logical disk of a mirrored virtual disk online in order to start mirror recovery.

SYNTAX

Force-DcsVirtualDiskOnline   -VirtualDisk <Object>   -Server <String>   [ -Yes]   [ -Connection <String> ]   [ -PipelineVariable <String> ]   [ -WhatIf]   [ -Confirm]

DESCRIPTION

Forces a logical disk of a mirrored virtual disk online in order to start mirror recovery. This operation is only valid when the data status of both storage sources of a virtual disk are not defined, unknown, or double failure.WARNING: This operation involves risks and should be used with extreme caution. Recovering from the incorrect storage source will result in data loss.

PARAMETERS

-VirtualDisk<Object>
VirtualDiskData object, name, or ID that identifies the virtual disk.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Server<String>
Computer name or ID of the server that will own the history log. The computer name must be unique or the name must be fully qualified.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Yes<SwitchParameter>
Forcing a virtual disk online is an operation that requires confirmation. Specify this parameter to confirm your intention to force online and prevent user interaction during scripted scenarios. If this parameter is not specified, user interaction will be required.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-WhatIf<SwitchParameter>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Confirm<SwitchParameter>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

VirtualDiskData : Object that identifies and describes the virtual disk.

OUTPUTS

LogicalDiskData : Object the identifies and describes the logical disk.

NOTES

Also see Get-DcsVirtualDisk

EXAMPLES

-------------- Example 1 Forces a virtual disk specified by name --------------

Force-DcsVirtualDiskOnline -VirtualDisk "Virtual Disk 1" -Server SSV1 -Yes

Forces the virtual disk named "Virtual Disk 1" on the server named SSV1 to come online. The Yes parameter was included to eliminate the need to confirm the operation.

StreamDiskId :
RetentionTime : 0
StreamSize : 0.00 B
StreamState : NotPresent
PoolId : F5381494-7319-4F56-8890-01705D0F5227:{8576dcad-eb64-11e0-81b0-00155d11e921}
VolumeIndex : 5
MinQuota : 0.00 B
MaxQuota : 0.00 B
TierAffinity : {1, 2, 3}
StorageName :
InReclamation : False
DataStatus : NotUpToDate
PresenceStatus : Present
Size : 1.00 PB
Description :
DiskStatus : Online
Virtualized : True
ClientAccessRights : NoAccess
Failure : Healthy
VirtualDiskId : 3b535f138ef243e19f10095c73742f6f
DiskRole : First
ServerHostId : F5381494-7319-4F56-8890-01705D0F5227
IsMapped : True
Protected : True
Id : LD:F5381494-7319-4F56-8890-01705D0F5227_V.{8576dcad-eb64-11e0-81b0-00155d11e921}-00000005
Caption : Virtual disk 1 on SSV1
ExtendedCaption : Virtual disk 1 on SSV1
Internal : False
     

To Table of Contents

NAME

Get-DcsAction

SYNOPSIS

Returns actions associated with a task.

SYNTAX

Get-DcsAction   [ -Task <String> ]   [ -Action <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns actions associated with a task. One specific action or all actions for the specified task will be be returned.

PARAMETERS

-Task<String>
Name, or ID that identifies the task.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Action<Object>
TaskActionData object, name or ID that identifies the action. If the action is specified, only that action will be returned. If not specified, all actions will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

TaskActionData : Object the identifies and describes the action of a task.

OUTPUTS

TaskActionData : Object the identifies and describes the action of a task.

NOTES

Also see Get-DcsTask, Get-DcsAction, Get-DcsTrigger, Set-DcsAction, Remove-DcsAction.

EXAMPLES

-------------- Example 1 Returns all actions for a task specified by name --------------

Get-DcsAction -Task "Task 1"

Returns all actions (2) associated with the task named "Task 1".

RecipientId : 9b400063-4e5f-4652-be8a-b3eba1dde95a
TaskId : 32651f76-72e9-4852-ba35-0b111eaa7808
Type : SendNotification
Id : 8442e56b-a1c9-4485-8b45-8d08ce9c3bd4
Caption : Send email to Moe Howard
ExtendedCaption :
Internal : False
     
RecipientId : d8e402d3-8458-4948-912b-95c0b77eb2f1
TaskId : 32651f76-72e9-4852-ba35-0b111eaa7808
Type : SendNotification
Id : 6bb6302b-3530-4a65-a65f-06735c835bbb
Caption : Send email to Curly Howard
ExtendedCaption :
Internal : False
     

To Table of Contents

NAME

Get-DcsAlert

SYNOPSIS

Returns data for all alerts for all servers in the specified connection.

SYNTAX

Get-DcsAlert   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns data for all alerts for all servers in the specified connection.

PARAMETERS

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

LogMessageData : Object that identifies and describes the alert message.

NOTES

Also see Clear-DcsAlert, Get-DcsLogMessage, Add-DcsLogMessage.

EXAMPLES

-------------- Example 1 Returns alert data for the server group --------------

Get-DcsAlert

Returns data for all alerts on servers in the server group. In this case there were two alerts.

Id : DataCore.Executive.LogMessageId
TimeStamp : 8/8/2011 6:56:41 PM
MachineName : SSV1
Level : Warning
Visibility : Customer
HighPriority : True
NeedsAcknowledge : False
MessageText : CHECK THE EVENT LOG! A WARNING MESSAGE HAS BEEN RECEIVED. [Triggered by One-Time Scheduler: 8/8/2011
2 : 55:00 PM on 8/8/2011 2:55:00 PM]
MessageData :
UserId :
UserName :
Caller : MessageAction.DoRun
Sources : {f9b6dcc0-5c79-42be-ba39-6d44884cb08c}
     
Id : DataCore.Executive.LogMessageId
TimeStamp : 8/8/2011 6:50:50 PM
MachineName : SSV1
Level : Error
Visibility : Customer
HighPriority : True
NeedsAcknowledge : False
MessageText : CHECK THE EVENT LOG! AN ERROR MESSAGE HAS BEEN RECEIVED. [Triggered by One-Time Scheduler: 8/8/2011
2 : 50:00 PM on 8/8/2011 2:50:00 PM]
MessageData :
UserId :
UserName :
Caller : MessageAction.DoRun
Sources : {f2163298-82f3-4b6e-a7d3-1b0e3fa0497c}
     

To Table of Contents

NAME

Get-DcsAllocationMap

SYNOPSIS

Retrieves the current allocation map of a virtual disk on a specified server (logical disk).

SYNTAX

Get-DcsAllocationMap   -VirtualDisk <Object>   -Server <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Retrieves the current allocation map of a virtual disk on a specified server (logical disk). The cmdlet returns allocations from the logical disk perspective, which chunks (logical disk SAU offsets) are allocated or not, regardless of the physical disk on which they reside. Returned data includes the Bitmap and Count for the logical disk. Each bit in the bit array corresponds to an SAU for the logical disk. The actual byte offset of this SAU can be determined by its position and the SAU size of the pool. The Count is determined by the number of chunks that logical disk contains (VD size divided by SAU size). If the corresponding bit is set to 1 (or True), the SAU is allocated. See the example for more information on the Bitmap.

PARAMETERS

-VirtualDisk<Object>
VirtualDiskData object, name or ID that identifies a virtual disk.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Server<Object>
ServerHostData object, computer name or ID that identifies the server with the virtual disk storage source from which to get an allocation map. The computer name must be unique or the name must be fully qualified.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

BitArrrayEx : Object that displays the bitmap and bit count for the logical disk.

NOTES

Also see Get-DcsChunkAllocationMap, Get-DcsChunkAllocation, Get-DcsChunkReclamationMap, Get-DcsVirtualDisk. The difference between Get-DcsAllocationMap and Get-DcsChunkAllocationMap is that the later returns allocations from the physical disk perspective (how many chunks are allocated on each physical disk for the specified logical disk), and the former returns the allocations from the logical disk perspective (which chunks are allocated or not regardless of the physical disk on which they reside). This function is highly volatile because I/O may change at any time. The call will throw an exception if the chunk allocation changes while getting the data. In this case, rerun the cmdlet.

EXAMPLES

-------------- Example 1 Retrieves current logical disk allocation map for a specified virtual disk and server. --------------

Get-DcsAllocationMap -VirtualDisk "Virtual disk 1" -Server "SSVVM01"

The cmdlet is invoked to obtain the logical disk allocation map of the virtual disk named "Virtual disk 1" on the server named "SSVVM01". The Bitmap and Count is returned. In this example, the Count is 80 and the BitMap consists of 10 bytes. 
The entire Bitmap is truncated. One way to see the entire BitMap would be to save the results to a variable and print the contents to the screen:
ForEach ($bit in $map) {Write-Host $bit.Bitmap}
171 84 37 83 149 170 84 165 74 213

To Table of Contents

NAME

Get-DcsBackUpFolder

SYNOPSIS

Returns the path of the folder assigned to store the configuration backup for the specified server.

SYNTAX

Get-DcsBackUpFolder   -Server <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns the path of the folder assigned to store the configuration backup for the specified server.

PARAMETERS

-Server<Object>
ServerHostData object, computer name, or ID that identifies the server. The computer name must be unique or the name must be fully qualified.

Required: true
Position: 1
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

ServerHostData : Object that identifies and describes the server.

OUTPUTS

string : Complete path of the backup folder.

NOTES

Also see Set-DcsBackupFolder, Backup-DcsConfiguration.

EXAMPLES

-------------- Example 1 Returns the path of the backup folder for a server specified by name --------------

Get-DcsBackupFolder -Server SSV1

Returns the path of the backup folder for the server named "SSV1".

C:\Program Files\DataCore\SANsymphony\Backups\
                                

-------------- Example 2 Returns the path to the backup folder for all servers by piping objects --------------

Get-DcsServer | Get-DcsBackUpFolder

The server objects were obtained using the cmdlet Get-DcsServer and piped to Get-DcsBackupFolder resulting in the paths to the backup folders for both servers in the server group.

C:\Program Files\DataCore\SANsymphony\Backups\
C:\Program Files\DataCore\SANsymphony\Backups\
                                

To Table of Contents

NAME

Get-DcsChunkAllocation

SYNOPSIS

Returns storage allocation unit (SAU) data for each physical disk in a disk pool. Data returned can be used to determine allocation distribution for disks in a pool.

SYNTAX

Get-DcsChunkAllocation   [ -Server <String> ]   -Pool <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns storage allocation unit (SAU) data for each physical disk in a disk pool. Data returned can be used to determine allocation distribution for disks in a pool. The returned object can be saved to a variable and used to get the total bit (SAU) count and view the actual bitmap data for each byte of each disk. This cmdlet can be used to determine if SAUs are allocated on a pool disk.

PARAMETERS

-Server<String>
Computer name or ID of the server. The computer name must be unique or the name must be fully qualified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Pool<Object>
DiskPoolData object, name, or ID that identifies the disk pool. To resolve by name, the name must be unique to the server group or the server must be specified.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

DiskPoolData : Object that identifies and describes the pool.

OUTPUTS

DiskAllocationInfoData : Object that associates the location for each SAU within the respective physical disks in a pool.

NOTES

The amount of bytes allocated and other performance data for pools can be retrieved by the cmdlet Get-DcsPerformanceCounter. Also see Get-DcsPool, Get-DcsChunkAllocationMap, Get-DcsChunkReclamationMap.

EXAMPLES

-------------- Example 1 Returns data for a specified pool, finds the properties in the returned object, and displays the number of bits and bitmap for each disk in the pool --------------

$ChunksAlloc = Get-DcsChunkAllocation -Server SSV1 -Pool "Disk pool 1"

$ChunksAlloc

PoolMemberId                                                          ChunkMap
------------                                                          --------
c358e4a6-26e0-4f07-aa9e-e780fff049bb                                  DataCore.Executive.BitArrayEx
4407d9de-8022-40d3-be64-5db8eaf44260                                  DataCore.Executive.BitArrayEx

$ChunksAlloc[0].ChunkMap | get-member


   TypeName: DataCore.Executive.BitArrayEx

Name        MemberType            Definition
----        ----------            ----------
Equals      Method                bool Equals(System.Object other)
GetHashCode Method                int GetHashCode()
GetType     Method                type GetType()
Or          Method                System.Void Or(DataCore.Executive.BitArrayEx otherBitArrayEx)
ToString    Method                string ToString()
Item        ParameterizedProperty bool Item(int index) {get;set;}
BitMap      Property              System.Byte[] BitMap {get;set;}
Count       Property              System.Int32 Count {get;set;}

$ChunksAlloc[0].ChunkMap

BitMap                                                               Count
------                                                               -----
{254, 255, 255, 255...}                                              397

ForEach ($c in $ChunksAlloc)
{
   Write-Host  (Get-DcsPhysicalDisk -PoolMember $c.PoolMemberid).ExtendedCaption
   Write-Host 
   Write-Host "Number of Bits in BitMap =" $c.ChunkMap.Count
   Write-Host "BitMap:"
   Write-Host $c.ChunkMap.BitMap
   Write-Host
}

The chunk allocation data (SAUs) for each disk in the pool named "Disk Pool 1" on the server named "SSV1" is returned and stored in the variable $ChunksAlloc. The contents of the variable are output. There are two physical disks in the pool. The Pool Member ID and Chunk Map are returned for both pool disks. The PowerShell cmdlet Get-Member can be used to find the properties for the ChunkMap object, which are Count and Bitmap. The ChunkMap object for the first record in the variable is displayed. A script shows one way to ouput the Count and entire BitMap for each disk. The cmdlet Get-DcsPhysicalDisk uses the PoolMemberId to find the disk name. The variable $ChunksAlloc is used to output the bit count and actual bitmap from the ChunkMap object for each disk in the pool. The bitmap is displayed in a series of bytes in decimal that represent a bitmap of the SAU allocation for a disk. The disk size divided by the SAU size is equal to the number of SAUs or bits.

Disk 5 on SSV1

Number of Bits in BitMap = 397
BitMap:
254 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 127 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Disk 6 on SSV1

Number of Bits in BitMap = 397
BitMap:
250 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 127 3 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
                                

-------------- Example 2 Returns bitmap and count data for all pools in a server group --------------

$Servers = Get-DcsServer
ForEach ($s in $Servers) 
{ 
   $Pools = Get-DcsPool -Server $s
   ForEach ($p in $Pools) 
   {
      Write-Host "Pool Name =" $p.ExtendedCaption -foregroundcolor Yellow
      Write-Host 
      $ChunksAllocs = Get-DcsChunkAllocation -Server $s -Pool $p
      ForEach ($c in $ChunksAllocs)
      {
         Write-Host  (Get-DcsPhysicalDisk -PoolMember $c.PoolMemberid).ExtendedCaption 
         Write-Host "Number of Bits in BitMap =" $c.ChunkMap.Count
         Write-Host "BitMap:"
         Write-Host $c.ChunkMap.BitMap
         Write-Host
      }
   }
}

This simple script file builds on the basics shown in Example 1 and shows one way to get bitmap and count data for all pools in a server group. The cmdlet Get-DcsServer is invoked to get the ServerHostData objects for all servers in the server group of the default connection; the objects are stored in the variable $Servers. The cmdlet Get-DcsPool is invoked to get DiskPoolData objects for all pools for all servers; those objects are stored in the variable $Pools. For each pool, the name is output to the screen in yellow. The cmdlet Get-DcsChunkAllocation is invoked for each pool on each server. The cmdlet Get-DcsPhysicalDisk is used with the PoolMemberId to output the disk name. The variable $ChunkAllocs is used to output the Count and the actual Bitmap in the ChunkMap object. In this case there are three servers in the server group: SSV1, SSV2 and SSV3. Each server has a pool (Disk pool 1 on SSV1, Disk pool 2 on SSV2, and Disk pool 3 on SSV3)and all servers share a pool (Shared pool 1). Each pool has two disks.

Pool Name = Disk pool 1 on SSV1

Disk 5 on SSV1
Number of Bits in BitMap = 397
BitMap:
254 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 127 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Disk 6 on SSV1
Number of Bits in BitMap = 397
BitMap:
254 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Pool Name = Shared pool 1 on SSV1

Shared Disk 2 on SSV1
Number of Bits in BitMap = 317
BitMap:
254 255 255 255 255 255 255 255 87 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 

Shared Disk 1 on SSV1
Number of Bits in BitMap = 477
BitMap:
254 255 255 255 255 255 255 255 63 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Pool Name = Disk pool 2 on SSV2

Disk 11 on SSV2
Number of Bits in BitMap = 397
BitMap:
254 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 127 223 255 255 15 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Disk 9 on SSV2
Number of Bits in BitMap = 397
BitMap:
254 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 223 251 255 255 191 255 255 31 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Pool Name = Shared pool 1 on SSV2

Shared Disk 2 on SSV1
Number of Bits in BitMap = 317
BitMap:
254 255 255 255 255 255 255 255 87 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Shared Disk 1 on SSV1
Number of Bits in BitMap = 477
BitMap:
254 255 255 255 255 255 255 255 63 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Pool Name = Disk pool 3 on SSV3

Disk 4 on SSV3
Number of Bits in BitMap = 397
BitMap:
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Disk 3 on SSV3
Number of Bits in BitMap = 397
BitMap:
0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Pool Name = Shared pool 1 on SSV3

Shared Disk 2 on SSV1
Number of Bits in BitMap = 317
BitMap:
254 255 255 255 255 255 255 255 87 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Shared Disk 1 on SSV1
Number of Bits in BitMap = 477
BitMap:
254 255 255 255 255 255 255 255 63 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
                                

To Table of Contents

NAME

Get-DcsChunkAllocationMap

SYNOPSIS

Returns storage allocation unit (SAU) data for a specified virtual disk in a pool on a particular server (also known as a logical disk).

SYNTAX

Get-DcsChunkAllocationMap   -VirtualDisk <Object>   -Server <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns storage allocation unit (SAU) data for a specified virtual disk in a pool on a particular server (also known as a logical disk). The cmdlet shows how many chunks are allocated on each physical disk (physical disk SAU offsets) in a pool. Data returned can be used to determine allocation distribution for the virtual disk on disks in the pool.

PARAMETERS

-VirtualDisk<Object>
VirtualDiskData object, name or ID of the virtual disk. The object can be obtained from Get-DcsVirtualDisk.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Server<Object>
Computer name or ID of the server. The computer name must be unique or the name must be fully qualified.

Required: true
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

VirtualDiskData : Object that identifies and describes the virtual disk.

OUTPUTS

DiskAllocationInfoData : Object that associates the location for each SAU within the respective physical disks for a specified virtual disk storage source.

NOTES

Also see Get-DcsAllocationMap, Get-DcsChunkAllocation, Get-DcsChunkReclamationMap, Get-DcsVirtualDisk. The difference between Get-DcsChunkAllocationMap and Get-DcsAllocationMap is that the former returns allocations from the physical disk perspective (how many chunks are allocated on each physical disk for the specified logical disk), and the later returns the allocations from the logical disk perspective (which chunks are allocated or not regardless of the physical disk on which they reside). This function is highly volatile because I/O may change at any time. The call will throw an exception if the chunk allocation changes while getting the data. In this case, rerun the cmdlet.

EXAMPLES

-------------- Example 1 Returns data for a specified virtual disk --------------

$VDChunksAllocMap = Get-DcsChunkAllocationMap -VirtualDisk "Virtual disk 10" -Server SSV1

$VDChunksAllocMap

PoolMemberId                                                          ChunkMap
------------                                                          --------
c358e4a6-26e0-4f07-aa9e-e780fff049bb                                  DataCore.Executive.BitArrayEx
4407d9de-8022-40d3-be64-5db8eaf44260                                  DataCore.Executive.BitArrayEx

$VDChunksAllocMap[0].ChunkMap | Get-Member

   TypeName: DataCore.Executive.BitArrayEx

Name        MemberType            Definition
----        ----------            ----------
Equals      Method                bool Equals(System.Object other)
GetHashCode Method                int GetHashCode()
GetType     Method                type GetType()
Or          Method                System.Void Or(DataCore.Executive.BitArrayEx otherBitArrayEx)
ToString    Method                string ToString()
Item        ParameterizedProperty bool Item(int index) {get;set;}
BitMap      Property              System.Byte[] BitMap {get;set;}
Count       Property              System.Int32 Count {get;set;}

$VDChunksAllocMap[0].ChunkMap

BitMap                                                                                                                                Count
------                                                                                                                                -----
{248, 255, 255, 255...}                                                                                                                 397

$VDChunksAllocMap = Get-DcsChunkAllocationMap -VirtualDisk "Virtual disk 10" -Server SSV1
ForEach ($d in $VDChunksAllocMap)
{
   Write-Host (Get-DcsPhysicalDisk -PoolMember $d.PoolMemberid).ExtendedCaption
   Write-Host 
   Write-Host "Number of Bits in BitMap =" $d.ChunkMap.Count
   Write-Host "BitMap:"
   Write-Host $d.ChunkMap.BitMap
   Write-Host
}

Chunk allocation data (SAUs) is returned for the virtual disk named "Virtual disk 10" on the server named "SSV1" and stored in the variable $VDChunksAllocMap. The contents of the variable are output. There are two physical disks are in the pool. The Pool Member ID and Chunk Map are returned for the disks. The PowerShell cmdlet Get-Member can be used to get the properties of the ChunkMap object, which are Bitmap and Count (total number of bits). The ChunkMap object for the first record in the variable is displayed. A script file shows one way to output the ChunkMap data for each disk. The cmdlet Get-DcsPhysicalDisk is used to get the disk name from the PoolMemberId. The variable $VDChunksAllocMap is used to output the bit count and actual bitmap from the ChunkMap object for each disk in the pool that stores the virtual disk data. The bitmap is displayed in a series of bytes in decimal that represent a bitmap of the SAU allocation for a disk. The disk size divided by the SAU size is equal to the number of SAUs or bits.

Disk 5 on SSV1

Number of Bits in BitMap = 397
BitMap:
248 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 29 252 255 127 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Disk 6 on SSV1

Number of Bits in BitMap = 397
BitMap:
248 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 21 249 255 127 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
                                

To Table of Contents

NAME

Get-DcsChunkReclamationMap

SYNOPSIS

Returns storage allocation unit (SAU) data for SAUs in reclamation in a disk pool. Data returned can be used to determine the distribution for SAUs in reclamation in a pool.

SYNTAX

Get-DcsChunkReclamationMap   [ -Server <String> ]   -Pool <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Gets the storage allocation unit (SAU) data for SAUs in reclamation in a disk pool. Data returned can be used to determine the distribution for SAUs in reclamation in a pool.

PARAMETERS

-Server<String>
Computer name or ID of the server. The computer name must be unique or the name must be fully qualified.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Pool<Object>
DiskPoolData object, name, or ID that identifies the disk pool. To resolve by name, the name must be unique to the server group or the server must be specified.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

DiskPoolData : Object that identifies and describes the pool.

OUTPUTS

DiskAllocationInfoData : Object that associates the location for each SAU in reclamation within the respective physical disks.

NOTES

Also see Get-DcsPool, Get-DcsChunkAllocation, Get-DcsChunkAllocationMap.

EXAMPLES

-------------- Example 1 Returns the reclamation map for a specified disk pool --------------

$ReclaimMap = Get-DcsChunkReclamationMap -Pool "Disk pool 1"

$ReclaimMap

PoolMemberId                                                          ChunkMap
------------                                                          --------
c358e4a6-26e0-4f07-aa9e-e780fff049bb                                  DataCore.Executive.BitArrayEx
4407d9de-8022-40d3-be64-5db8eaf44260                                  DataCore.Executive.BitArrayEx

$ReclaimMap = Get-DcsChunkReclamationMap -Pool "Disk pool 1"
ForEach ($d in $ReclaimMap)
{
   Write-Host (Get-DcsPhysicalDisk -PoolMember $d.PoolMemberid).ExtendedCaption
   Write-Host
   Write-Host "Number of Bits in BitMap =" $d.ChunkMap.Count
   Write-Host "BitMap:"
   Write-Host $d.ChunkMap.BitMap
   Write-Host
}

The cmdlet is invoked to obtain the reclamation map for the pool named "Disk pool 1" on the server "SSV1" and is stored in the variable $ReclaimMap. The output for the variable is displayed. Two physical disks are in the pool. The Pool Member ID and Chunk Map are returned for the disks. The PowerShell cmdlet Get-Member can be used to get the properties of the ChunkMap object, which are Bitmap and Count (total number of bits). A script file shows one way to output the ChunkMap data for each disk. The cmdlet Get-DcsPhysicalDisk is used to get the disk name from the PoolMemberId. The variable $ReclaimMap is used to get the total number of bits and the actual bitmap for each disk that has SAUs that are being reclaimed. When reclamation is complete, the BitMap will have no bits set. The bitmap is displayed in a series of bytes in decimal that represent a bitmap of the SAUs in reclamation on a disk. The disk size divided by the SAU size is equal to the number of SAUs or bits.

Disk 5 on SSV1

Number of Bits in BitMap = 397
BitMap:
112 255 255 239 255 191 255 255 255 247 255 255 191 187 127 255 239 255 29 180 255 123 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Disk 6 on SSV1

Number of Bits in BitMap = 397
BitMap:
248 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 255 21 249 255 127 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
                                

To Table of Contents

NAME

Get-DcsClient

SYNOPSIS

Returns data for clients (hosts).

SYNTAX

Get-DcsClient   [ -Client <Object> ]   [ -Group <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns data for clients (hosts). Filtering parameters may be specified to narrow the scope of the data returned. If no parameters are specified, data for all clients associated with the default connection will be returned.

PARAMETERS

-Client<Object>
ClientHostData object, name, or ID that identifies a client. If specified, only data for that client will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Group<Object>
HostGroupData, Id or name of the host group. Use this parameter to return data for client hosts that belong to a specific host group.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

ClientHostData or HostGroupData : Object that identifies and describes the client or host group.

OUTPUTS

ClientHostData : Object that identifies and describes the client.

NOTES

Also see Remove-DcsClient, Remove-DcsClientPort, Register-DcsClientPort, Set-DcsClientProperties, Set-DcsPortProperties.

EXAMPLES

-------------- Example 1 Returns data for a client specified by name --------------

Get-DcsClient -Client "Host VM1"

Returns data for the client host named "Host VM1".

HostGroupId : {94f8347a-e846-46cb-aa63-b2d343b0e41d}
Type : WindowsServer2008
State : PortsConnected
AluaSupport : True
PathPolicy : PreferredServer
PreferredServerId :
Description :
HostName : Host VM1
MpioCapable : True
SequenceNumber : 34634
Id : 522f9c1287c145c7888c752dd7b7f325
Caption : Host VM1
ExtendedCaption : Host VM1
Internal : False
     

To Table of Contents

NAME

Get-DcsClientPreferredServer

SYNOPSIS

Returns client-preferred server relationships that show which servers are associated with which clients (hosts).

SYNTAX

Get-DcsClientPreferredServer   [ -Client <Object> ]   [ -Server <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Get-DcsClientPreferredServer   -ClientPreferredServer <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns client-preferred server relationships that show which servers are associated with which clients (hosts). Filtering parameters may be specified to narrow the scope of the data returned. Preferred server data can be returned for a specific client (host), a specific server, or a specific client-preferred server relationship. If no parameters are specified, data for all client-preferred server relationships in the server group is returned.

PARAMETERS

-Client<Object>
ClientHostData object, name, or ID that identifies a client (host). If specified, only data for that client will be returned.

Required: false
Position: 1
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Server<Object>
ServerHostData object, computer name or ID that identifies a server. The computer name must be unique or the name must be fully qualified. If the server is specified, only data for that server will be returned.

Required: false
Position: 2
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-ClientPreferredServer<Object>
ClientServerRelationData object, ID, or caption that identifies a client-preferred server relationship. If specified, only data for that relationship will be returned. The caption is the name of the host followed by the name of the preferred server in this format: "HostVM1 | SSVVM01".

Required: true
Position: 1
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

ServerHostData : Object that identifies and describes the server.

OUTPUTS

ClientServerRelationData : Object that identifies the preferred server relationship between a client (host ) and preferred server.

NOTES

A Preferred Server setting of "Auto select" returns no data since no preferred server is specifically set. A host enabled for ALUA with a Preferred Server setting of "ALL" returns no data. In this case, the path policy is Symmetrical, which means that all available paths are utilized equally, therefore no server is preferred.

EXAMPLES

-------------- Example 1 Returns data for a specified client --------------

Get-DcsClientPreferredServer -Client "HostVM1"

The cmdlet is invoked to get the preferred server data for the client (host) named "HostVM1". Two ClientServerRelationData objects are returned. The Caption in the objects show that the servers named "SSVVM01" and "SSVVM02" are preferred servers for the specified client.

ClientId : 549da3ce079b49cb9f895d884042722a
ServerId : 2D78E1A3-FECB-413F-B20F-70340176CF79
SequenceNumber : 10914
Id : c303694d-0ee3-4041-898d-6e9e714296dd
Caption : HostVM1 | SSVVM01
ExtendedCaption : HostVM1 | SSVVM01
Internal : False
     
ClientId : 549da3ce079b49cb9f895d884042722a
ServerId : 991725E0-A887-4CAA-AAA4-D37D972334C8
SequenceNumber : 10915
Id : 24ba2893-6132-4774-bf5b-0f11fdeacfef
Caption : HostVM1 | SSVVM02
ExtendedCaption : HostVM1 | SSVVM02
Internal : False
     

-------------- Example 2 Returns data for a specified server --------------

Get-DcsServer -Server "SSVVM01" | Get-DcsClientPreferredServer

The cmdlet is invoked to get the preferred server data for the server named "SSVVM01". The cmdlet Get-DcsServer is invoked to return the ServerHostData object for the server and the object is piped to the cmdlet Get-DcsClientPreferredServer. Two ClientServerRelationData objects are returned. The Caption in the objects show that the specified server "SSVVM01" is preferred for the Clients (hosts) named "HostVM1" and "HostVM2".

ClientId : f2c26a44d9784647b6168f168b1ad517
ServerId : 2D78E1A3-FECB-413F-B20F-70340176CF79
SequenceNumber : 10912
Id : 1a40c644-4301-4a2c-a890-6dacaa173fd0
Caption : HostVM2 | SSVVM01
ExtendedCaption : HostVM2 | SSVVM01
Internal : False
     
ClientId : 549da3ce079b49cb9f895d884042722a
ServerId : 2D78E1A3-FECB-413F-B20F-70340176CF79
SequenceNumber : 10914
Id : c303694d-0ee3-4041-898d-6e9e714296dd
Caption : HostVM1 | SSVVM01
ExtendedCaption : HostVM1 | SSVVM01
Internal : False
     

-------------- Example 3 Returns data for a specified clientpreferred server relationship --------------

Get-DcsClientPreferredServer -ClientPreferredServer "HostVM1 | SSVVM01"

The cmdlet is invoked using the caption of the client-preferred server "HostVM1 | SSVVM01" to return the object that shows the relationship between the client named "HostVM1" and the preferred server named "SSVVM01".

ClientId : 549da3ce079b49cb9f895d884042722a
ServerId : 2D78E1A3-FECB-413F-B20F-70340176CF79
SequenceNumber : 10914
Id : c303694d-0ee3-4041-898d-6e9e714296dd
Caption : HostVM1 | SSVVM01
ExtendedCaption : HostVM1 | SSVVM01
Internal : False
     

To Table of Contents

NAME

Get-DcsConfigurationState

SYNOPSIS

Returns the server group configuration state for the specified connection.

SYNTAX

Get-DcsConfigurationState   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns the server group configuration state for the specified connection.

PARAMETERS

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

ConfigurationData : Object describing the state of the server group configuration.

NOTES

Also see Synch-DcsConfiguration, Get-DcsServer, Get-DcsServerGroup, Get-DcsServerInfo.

EXAMPLES

-------------- Example 1 Returns the configuration state of the local server group --------------

Get-DcsConfigurationState

Returns the configuration state of the local server group.

State : Synchronized
Source :
Id : dd261697-6e3c-47d6-8a6d-034adb0ee163
Caption :
ExtendedCaption :
Internal : False
     

To Table of Contents

NAME

Get-DcsConnection

SYNOPSIS

Displays the names of all connections created for the server group.

SYNTAX

Get-DcsConnection   [ -PipelineVariable <String> ]

DESCRIPTION

Displays the names of all connections created for the server group. The connections were created using Connect-DcsServer.

PARAMETERS

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

string : Aliases of all connections for the server group.

NOTES

Also see Get-DcsDefaultConnection, Set-DcsDefaultConnection.

EXAMPLES

-------------- Example 1 Returns all connections --------------

Get-DcsConnection

Lists the connections for this server group.

SSV1Connect
SSV2Connect
localhost
                                

To Table of Contents

NAME

Get-DcsDefaultConnection

SYNOPSIS

Displays the default connection.

SYNTAX

Get-DcsDefaultConnection   [ -PipelineVariable <String> ]

DESCRIPTION

Displays the default connection. The default connection is assigned using Set-DcsDefaultConnection, or will be the last connection made.

PARAMETERS

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

string : The alias of the default connection.

NOTES

Also see Set-DcsDefaultConnection, Get-DcsConnection.

EXAMPLES

-------------- Example 1 Returns the default connection --------------

Get-DcsDefaultConnection

Returns the default connection for the server group. The name of the connection is "SSV1Connect", as shown by the output.

SSV1Connect
                                

To Table of Contents

NAME

Get-DcsDiskPath

SYNOPSIS

THIS CMDLET IS OBSOLETE, use Get-DcsPhysicalDiskPath.

SYNTAX

Get-DcsDiskPath   [ -Server <String> ]   [ -Disk <String> ]   [ -Port <String> ]   [ -DiskPath <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

THIS CMDLET IS OBSOLETE, use Get-DcsPhysicalDiskPath.

PARAMETERS

-Server<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Disk<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Port<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-DiskPath<Object>

Required: false
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

DiskPathData : Object that identifies and describes the paths for a physical disk.

OUTPUTS

DiskPathData : Object that identifies and describes the paths for a physical disk.

NOTES

THIS CMDLET IS OBSOLETE, USE GET-DCSPHYSICALDISKPATH.

EXAMPLES

To Table of Contents

NAME

Get-DcsDistributionPlan

SYNOPSIS

Returns a distribution plan for a server in preparation of moving eligible logical disks (storage sources) to other servers without effecting virtual disk high availability. This cmdlet creates a distribution plan in order to perform the "Evacuate DataCore Server" or "Redistribute to DataCore Server" operations. Eligible virtual disks must have a storage source created from a shared pool and the destination server must share the same pool.

SYNTAX

Get-DcsDistributionPlan   -LogicalDisk <Object[]>   [ -DestinationServer <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns a distribution plan for a server in preparation of moving eligible logical disks (storage sources) to other servers without effecting virtual disk high availability. This cmdlet creates a distribution plan in order to perform the "Evacuate DataCore Server" or "Redistribute to DataCore Server" operations. Eligible virtual disks must have a storage source created from a shared pool and the destination server must share the same pool. The returned plan consists of an array of logical disk IDs with an associated server where the eligible storage sources will be moved. A warning is provided if storage sources are not eligible to be moved. Logical disks with warnings on the plan will not be moved. Actions can be taken to reduce warnings if desired and the cmdlet can be invoked again to get a new distribution plan. (See Start-DcsDistributionPlan to start the distribution of storage sources to other servers.)

PARAMETERS

-LogicalDisk<Object[]>
An array of LogicalDiskData objects, IDs or captions that identifies one or more logical disks to move. LogicalDiskData objects can be obtained from Get-DcsLogicalDisk.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-DestinationServer<Object>
ServerHostData object, computer name or ID that identifies the destination server where the storage sources should be moved and behaves in the same way as the "Redistribute to DataCore Server" operation in the user interface. The computer name must be unique or the name must be fully qualified. The ServerHostData object can be obtained from Get-DcsServer. If the DestinationServer parameter is not specified, the software will determine the best server based on balancing the load and the number of available paths and behaves in the same way as the "Evacuate DataCore Server" operation.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

LogicalDiskData [] : An array of LogicalDiskData objects that describe and identify the storage sources on a server.

OUTPUTS

LogicalDiskDistributionSet : Object that describes the distribution set which consists of an array of logical disk IDs and the associated server candidates and any warnings.

NOTES

Under certain circumstances, a distribution plan is not required, see Start-DcsDistributionPlan for more information.

EXAMPLES

-------------- Example 1 Returns the distribution plan for all storage sources on a specified server to evacuate virtual disks. --------------

$plan = Get-DcsLogicalDisk -Server SSV1 | Get-DcsDistributionPlan

This example creates a distribution plan for a "Evacuate DataCore Server" operation. The cmdlet Get-DcsLogicalDisk is invoked to obtain all LogicalDiskData objects for the server named "SSV1", which will be evacuating its logical disks. Those objects are piped to the cmdlet Get-DcsDistributionPlan to generate the distribution plan for the server "SSV1". The returned LogicalDiskDistributionSet object is saved to the variable $plan. The returned object lists each logical disk for that server, along with the server IDs to which the logical disks will be moved. No destination server was specified, so the software will select the most suitable destination server. Warnings are provided for seven logical disks, which will not be moved (unless actions are taken to remove the warnings and a new plan is generated). In this case there are four logical disks which have no warnings and will be moved in the event that the variable $plan is passed to the cmdlet Start-DcsDistributionPlan.

LogicalDiskId                                            Servers                                                                                                 Warnings
-------------                                            -------                                                                                                 --------
8c7cfd0d-6885-4575-9088-fd79b14197c4                     {606E5C02-8C8A-4562-8AB0-2D4FC5A90B81}                                                                      None
07a40cd1-be73-470d-96ed-a5e2d5e1bf69                     {606E5C02-8C8A-4562-8AB0-2D4FC5A90B81}                                                                      None
18038c60-9243-4d8a-9c92-3551c9a8b28a                     {606E5C02-8C8A-4562-8AB0-2D4FC5A90B81}                                                                      None
2a5de906-f3bc-4592-9f6f-e18b8dbd64a0                     {606E5C02-8C8A-4562-8AB0-2D4FC5A90B81}                                                                      None
acb5b7e5-c3f7-404a-88ee-d605e204f847                     {C8A77BC1-E998-4B73-90BF-DE7F097861C2}                                                IsSequentialStorageEnabled
1e9e5134-d88d-42c5-ad07-dfb9b1e7531d                     {606E5C02-8C8A-4562-8AB0-2D4FC5A90B81}                                                          IsRollbackSource
c141d228-9457-47b4-9801-2ecd491d5cf6                                                                                                         IsDataProtected, IsNotShared
7e988623-4833-42c0-8076-05e47f68363c                                                                                                                          IsNotShared
5a634ef3-b61b-4831-b0bc-2347b5dc9e63                                                                                                                          IsNotShared
798d7069-2c36-4ee8-9bd6-612d0567cac0                                                                                                                        IsNonMirrored
71b962e8-d009-4f0b-b2b1-3b8b4562b767                                                                              ... IsRollbackDestination, IsDataProtected, IsNotShared
0608e471-0c63-49d2-9b4c-a9ff8c3d0893                                                                        IsNotShared
cebda920-8a8b-45fa-bbaf-cc42ac0bced1                                                                        IsNotShared
                                

-------------- Example 2 Returns the distribution plan for a specified server and destination server to redistribute virtual disks and pipe the output directly to StartDcsDistributionPlan. --------------

Get-DcsLogicalDisk -Server SSV1 | Get-DcsDistributionPlan -DestinationServer SSV2 | Start-DcsDistributionPlan

This example creates a distribution plan for a "Redistribute to DataCore Server" operation. The cmdlet Get-DcsLogicalDisk is invoked to obtain all LogicalDiskData objects for the server named "SSV1". Those objects are piped to the cmdlet Get-DcsDistributionPlan to generate the distribution plan for the server "SSV1". The server named "SSV2" is specified as the destination server, where all eligible storage sources will be moved. The returned LogicalDiskDistributionSet object is piped directly to the cmdlet Start-DcsDistributionPlan and all logical disks with no warnings are moved to the server "SSV2". All logical disks with warnings are not moved.


To Table of Contents

NAME

Get-DcsHostGroup

SYNOPSIS

Returns data for a specific host group or all host groups in the server group of the specified connection.

SYNTAX

Get-DcsHostGroup   [ -Group <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns data for a specific host group or all host groups in the server group of the specified connection. If no parameters are specified, data for all host groups in the server group of the default connection will be returned.

PARAMETERS

-Group<Object>
HostGroupData object, name, or ID that identifies the host group. If specified, only data for that host group will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

HostGroupData : The object that identifies and describes the host group.

OUTPUTS

HostGroupData : The object that identifies and describes the host group.

NOTES

Also see Add-DcsHostGroup, Add-DcsHostToGroup, Remove-DcsHostGroup, Remove-DcsHostFromGroup, Set-DcsHostGroupProperties.

EXAMPLES

-------------- Example 1 Returns data for a host group specified by name --------------

Get-DcsHostGroup -Group "HostGroup1"

The cmdlet is invoked with the Group parameter specified as "HostGroup1" to return the HostGroupData object for the host group named "HostGroup1".

Alias : HostGroup1
Description :
SequenceNumber : 5006
Id : {04dcdfbf-109b-4a9c-9fd2-64ac9f5b5d8c}
Caption : HostGroup1
ExtendedCaption : HostGroup1
Internal : False
     

-------------- Example 2 Returns data for all host groups. --------------

Get-DcsHostGroup

The cmdlet is invoked without parameters to return the HostGroupData objects for all host groups in the server group of the default connection. Data for two host groups are returned.

Alias : HostGroup1
Description :
SequenceNumber : 5006
Id : {04dcdfbf-109b-4a9c-9fd2-64ac9f5b5d8c}
Caption : HostGroup1
ExtendedCaption : HostGroup1
Internal : False
     
Alias : HostGroup2
Description :
SequenceNumber : 5008
Id : {39662275-2f40-407b-ae12-d4557efde87c}
Caption : HostGroup2
ExtendedCaption : HostGroup2
Internal : False
     

To Table of Contents

NAME

Get-DcsLogicalDisk

SYNOPSIS

Returns logical disk (storage source) data.

SYNTAX

Get-DcsLogicalDisk   [ -Server <Object> ]   [ -VirtualDisk <Object> ]   [ -Pool <Object> ]   [ -LogicalDisk <Object> ]   [ -WithCdpEnabled <Boolean> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns logical disk (storage source) data. Filtering parameters may be specified to narrow the scope of the data returned. If no parameters are specified, logical disk data will be returned for all servers in the default connection.

PARAMETERS

-Server<Object>
Computer name or ID of a server. The computer name must be unique or the name must be fully qualified. If specified, only data for the designated server will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-VirtualDisk<Object>
VirtualDiskData object, name, or ID that identifies a virtual disk. If specified, only data for the designated virtual disk will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Pool<Object>
DiskPoolData object, name or ID that identifies a disk pool. To resolve by name, the name must be unique to the server group or the server must be specified. If a disk pool is specified, only data for that pool will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-LogicalDisk<Object>
LogicalDiskData object, ID or caption that identifies a logical disk. If specified, only data for that logical disk will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-WithCdpEnabled<Boolean>
Use this parameter to return logical disk data based on the Continuous Data Protection (CDP) setting. Specify $true to return data for logical disks with CDP enabled or $false to return data for logical disks with CDP disabled.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

VirtualDiskData : Object that identifies and describes the virtual disk.

OUTPUTS

LogicalDiskData : Object the identifies and describes the logical disk.

NOTES

Also see Get-DcsMirror, Get-DcsVirtualDiskLogicalUnit, Get-DcsChunkAllocationMap, Add-DcsVirtualDisk, Remove-DcsLogicalDisk. Note: The RetentionTime is the returned object is not to be confused with the Retention Period of a CDP-enabled virtual disk. See the examples of Get-DcsPerformanceCounter for an example to get the up-to-date Retention Period of a logical disk.

EXAMPLES

-------------- Example 1 Returns data for a pool specified by name --------------

Get-DcsLogicalDisk -Server SSV1 -Pool "Disk pool 1"

Returns data for all logical disks created from "Disk pool 1" on server "SSV1".

StreamDiskId :
RetentionTime : 0
StreamSize : 0.00 B
StreamState : NotPresent
PoolId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:{ea7c7a80-bdf3-11e0-8304-00155d11e921}
VolumeIndex : 45
MinQuota : 0.00 B
MaxQuota : 0.00 B
TierAffinity : {1, 2, 3}
StorageName :
InReclamation : False
DataStatus : UpToDate
PresenceStatus : Present
Size : 1.00 PB
Description :
DiskStatus : Online
Virtualized : True
ClientAccessRights : ReadWrite
Failure : Healthy
VirtualDiskId : 0dc5596489cb4d8ba0346f80eb47ad46
DiskRole : First
ServerHostId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4
IsMapped : True
Protected : True
Id : LD:84972D6B-7E71-4616-BDA1-57ECEAF3FFC4_V.{ea7c7a80-bdf3-11e0-8304-00155d11e921}-0000002D
Caption : Virtual disk 1 on SSV1
ExtendedCaption : Virtual disk 1 on SSV1
Internal : False
     
StreamDiskId :
RetentionTime : 0
StreamSize : 0.00 B
StreamState : NotPresent
PoolId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:{ea7c7a80-bdf3-11e0-8304-00155d11e921}
VolumeIndex : 46
MinQuota : 25.00 GB
MaxQuota : 0.00 B
TierAffinity : {1, 2, 3}
StorageName :
InReclamation : False
DataStatus : UpToDate
PresenceStatus : Present
Size : 1.00 PB
Description :
DiskStatus : Online
Virtualized : True
ClientAccessRights : ReadWrite
Failure : Healthy
VirtualDiskId : a6c21da23ec84baa80ab6a5c8c8c605c
DiskRole : First
ServerHostId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4
IsMapped : True
Protected : True
Id : LD:84972D6B-7E71-4616-BDA1-57ECEAF3FFC4_V.{ea7c7a80-bdf3-11e0-8304-00155d11e921}-0000002E
Caption : Virtual disk 2 on SSV1
ExtendedCaption : Virtual disk 2 on SSV1
Internal : False
     
StreamDiskId : LD:84972D6B-7E71-4616-BDA1-57ECEAF3FFC4_V.{ea7c7a80-bdf3-11e0-8304-00155d11e921}-00000031
RetentionTime : 36000000000
StreamSize : 2.50 GB
StreamState : Active
PoolId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:{ea7c7a80-bdf3-11e0-8304-00155d11e921}
VolumeIndex : 47
MinQuota : 0.00 B
MaxQuota : 0.00 B
TierAffinity : {1, 2, 3}
StorageName :
InReclamation : False
DataStatus : UpToDate
PresenceStatus : Present
Size : 1.00 PB
Description :
DiskStatus : Online
Virtualized : True
ClientAccessRights : ReadWrite
Failure : Healthy
VirtualDiskId : 635134ab2cad4b5d81af73ae5f09bd6f
DiskRole : First
ServerHostId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4
IsMapped : True
Protected : True
Id : LD:84972D6B-7E71-4616-BDA1-57ECEAF3FFC4_V.{ea7c7a80-bdf3-11e0-8304-00155d11e921}-0000002F
Caption : Virtual disk 3 on SSV1
ExtendedCaption : Virtual disk 3 on SSV1
Internal : False
     
StreamDiskId : LD:84972D6B-7E71-4616-BDA1-57ECEAF3FFC4_V.{ea7c7a80-bdf3-11e0-8304-00155d11e921}-00000033
RetentionTime : 36000000000
StreamSize : 2.50 GB
StreamState : Active
PoolId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:{ea7c7a80-bdf3-11e0-8304-00155d11e921}
VolumeIndex : 50
MinQuota : 0.00 B
MaxQuota : 0.00 B
TierAffinity : {1, 2, 3}
StorageName :
InReclamation : False
DataStatus : UpToDate
PresenceStatus : Present
Size : 1.00 PB
Description :
DiskStatus : Online
Virtualized : True
ClientAccessRights : ReadWrite
Failure : Healthy
VirtualDiskId : 54893a865cc4412d83b43ba09179996d
DiskRole : First
ServerHostId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4
IsMapped : False
Protected : True
Id : LD:84972D6B-7E71-4616-BDA1-57ECEAF3FFC4_V.{ea7c7a80-bdf3-11e0-8304-00155d11e921}-00000032
Caption : Virtual disk 3 @ 8/16/2011 10:10:20 AM on SSV1
ExtendedCaption : Virtual disk 3 @ 8/16/2011 10:10:20 AM on SSV1
Internal : False
     
StreamDiskId :
RetentionTime : 0
StreamSize : 0.00 B
StreamState : NotPresent
PoolId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:{ea7c7a80-bdf3-11e0-8304-00155d11e921}
VolumeIndex : 51
MinQuota : 0.00 B
MaxQuota : 0.00 B
TierAffinity : {1, 2, 3}
StorageName :
InReclamation : False
DataStatus : Undefined
PresenceStatus : Present
Size : 1.00 PB
Description :
DiskStatus : Online
Virtualized : False
ClientAccessRights : NotDefined
Failure : Undefined
VirtualDiskId :
DiskRole : Unknown
ServerHostId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4
IsMapped : False
Protected : True
Id : LD:84972D6B-7E71-4616-BDA1-57ECEAF3FFC4_V.{ea7c7a80-bdf3-11e0-8304-00155d11e921}-00000033
Caption : Log history of Virtual disk 3 @ 8/16/2011 10:10:20 AM on SSV1
ExtendedCaption : Log history of Virtual disk 3 @ 8/16/2011 10:10:20 AM on SSV1
Internal : False
     
StreamDiskId :
RetentionTime : 0
StreamSize : 0.00 B
StreamState : NotPresent
PoolId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:{ea7c7a80-bdf3-11e0-8304-00155d11e921}
VolumeIndex : 49
MinQuota : 2.50 GB
MaxQuota : 0.00 B
TierAffinity : {1, 2, 3}
StorageName :
InReclamation : False
DataStatus : Undefined
PresenceStatus : Present
Size : 1.00 PB
Description :
DiskStatus : Online
Virtualized : False
ClientAccessRights : NotDefined
Failure : Undefined
VirtualDiskId :
DiskRole : Unknown
ServerHostId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4
IsMapped : False
Protected : True
Id : LD:84972D6B-7E71-4616-BDA1-57ECEAF3FFC4_V.{ea7c7a80-bdf3-11e0-8304-00155d11e921}-00000031
Caption : Log history of Virtual disk 3 on SSV1
ExtendedCaption : Log history of Virtual disk 3 on SSV1
Internal : False
     

-------------- Example 2 Returns data for all virtual disks of a certain kind by piping objects --------------

Get-DcsVirtualDisk -Kind Snapshot | Get-DcsLogicalDisk

The cmdlet Get-DcsVirtualDisk is used to get virtual disk data for all snapshots in the server group. This data is piped to the cmdlet Get-DcsLogicalDisk resulting in logical disk data for all snapshots in the server group.

StreamDiskId :
RetentionTime : 0
StreamSize : 0.00 B
StreamState : NotPresent
PoolId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:{ea7c7a80-bdf3-11e0-8304-00155d11e921}
VolumeIndex : 52
MinQuota : 0.00 B
MaxQuota : 0.00 B
TierAffinity : {1, 2, 3}
StorageName :
InReclamation : False
DataStatus : UpToDate
PresenceStatus : Present
Size : 1.00 PB
Description :
DiskStatus : Online
Virtualized : True
ClientAccessRights : ReadWrite
Failure : Healthy
VirtualDiskId : ff93ddd9444b46cab5374a04f75cb20d
DiskRole : First
ServerHostId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4
IsMapped : False
Protected : True
Id : LD:84972D6B-7E71-4616-BDA1-57ECEAF3FFC4_V.{ea7c7a80-bdf3-11e0-8304-00155d11e921}-00000034
Caption : Virtual disk 1 @ 8/16/2011 10:16:12 AM on SSV1
ExtendedCaption : Virtual disk 1 @ 8/16/2011 10:16:12 AM on SSV1
Internal : False
     
StreamDiskId :
RetentionTime : 0
StreamSize : 0.00 B
StreamState : NotPresent
PoolId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:{ea7c7a80-bdf3-11e0-8304-00155d11e921}
VolumeIndex : 54
MinQuota : 0.00 B
MaxQuota : 0.00 B
TierAffinity : {1, 2, 3}
StorageName :
InReclamation : False
DataStatus : UpToDate
PresenceStatus : Present
Size : 1.00 PB
Description :
DiskStatus : Online
Virtualized : True
ClientAccessRights : ReadWrite
Failure : Healthy
VirtualDiskId : 47994570d6b54c59b7e8f8333afd3b9e
DiskRole : First
ServerHostId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4
IsMapped : False
Protected : True
Id : LD:84972D6B-7E71-4616-BDA1-57ECEAF3FFC4_V.{ea7c7a80-bdf3-11e0-8304-00155d11e921}-00000036
Caption : Virtual disk 2 @ 8/16/2011 10:16:26 AM on SSV1
ExtendedCaption : Virtual disk 2 @ 8/16/2011 10:16:26 AM on SSV1
Internal : False
     

To Table of Contents

NAME

Get-DcsLogMessage

SYNOPSIS

Returns Event Log messages for all servers in the connection.

SYNTAX

Get-DcsLogMessage   [ -Level <String[]> ]   [ -MatchLevel]   [ -SourceType <String[]> ]   [ -Source <Object> ]   [ -Count <Int32> ]   [ -StartTime <DateTime> ]   [ -EndTime <DateTime> ]   [ -Server <String[]> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns Event Log messages for all servers in the connection. Filtering parameters may be specified to narrow the scope of the data returned. If no parameters are specified, all log messages for all servers in the default connection will be returned.

PARAMETERS

-Level<String[]>
Name or ID that identifies one or more message types. Possible level parameters (in order from highest to lowest) include: "Diagnostic", "Error", "Warning", "Info", and "Trace". If specified, only data for the designated level and all higher levels will be returned. For instance, if the parameter value is "Warning" then all messages with "Diagnostic", "Error", and "Warning" will be returned. If the MatchLevel parmeter is specified, then only the levels that are specified in the Level parameter will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-MatchLevel<SwitchParameter>
This parameter allows specific level types to be returned. When specified, only the values entered for the Level parameter will be returned. For instance, if the values entered for the Level parameter is "Warning", "Error" then only the Warning and Error messages will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-SourceType<String[]>
Name or ID that identifies one or more SAN component types. If specified, only data for the designated source types will be returned. Valid values include: "General", "Diskpools", "Mirrors", "Monitors", "Paths", "Physical disks", "Ports", "Replications", "Rollbacks", "Security", "Snapshots", "Hosts", "DataCoreServers", "Tasks", "DiskSources", "VirtualDisks", and "Support".

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Source<Object>
The ID of any object identifying a particular source. (See SourceType for valid types.)

Required: false
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Count<Int32>
The Count parameter can limit the number of log messages returned. If specified, the number of messages returned will not exceed the parameter value.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-StartTime<DateTime>
This parameter specifies the start of the list of returned log messages. Only messages with the same date and time or later will be returned. A time frame can be specified by using both StartTime and EndTime. One way to provide the StartTime parameter would be by piping a variable created by invoking New-Object with the TypeName parameter of DateTime with the correct arguments (see the Help for New-Object, Get-Date). The StartTime parameter can also be provided in a string with the date and time. An example of the format to use is "04/06/2011 02:51:00 PM" which represents April 6, 2011 at 2:51 PM. This value must be in quotes.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-EndTime<DateTime>
This parameter specifies the end of the list of returned log messages. Only messages with the same date and time or earlier will be returned. A time frame can be specified by using both StartTime and EndTime. One way to provide the EndTime parameter would be by piping a variable created by invoking New-Object with the TypeName parameter of DateTime with the correct arguments (see the Help for New-Object, Get-Date). The EndTime parameter can also be provided in a string with the date and time. An example of the format to use is "04/06/2011 02:51:00 PM" which represents April 6, 2011 at 2:51 PM. This value must be in quotes.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Server<String[]>
Computer name or ID of one or more servers in a group. The computer name must be unique or the name must be fully qualified. Only data for the specified servers will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

Object : Any object that identifies the source.

OUTPUTS

LogMessageData : Object identifying the Event Log message.

NOTES

Also see Get-DcsAlert, Clear-DcsAlert, Add-DcsLogMessage

EXAMPLES

-------------- Example 1 Returns log messages of a specified level --------------

Get-DcsLogMessage -Level Warning -MatchLevel

The MatchLevel parameter is used to returns only log messages with a Level of "Warning".

Id : DataCore.Executive.LogMessageId
TimeStamp : 8/16/2011 10:10:41 AM
MachineName : SSV1
Level : Warning
Visibility : Customer
HighPriority : False
NeedsAcknowledge : False
MessageText : Failure status of {0} changed to {1}.
MessageData : {Virtual disk 3 @ 8/16/2011 10:10:20 AM on SSV1, No disk access}
UserId :
UserName :
Caller : LogicalDisk.UpdateCoreLogicalDiskData
Sources : {LD:84972D6B-7E71-4616-BDA1-57ECEAF3FFC4_V.{ea7c7a80-bdf3-11e0-8304-00155d11e921}-00000032, 54893a865cc4412d83b43ba09179996d}
     
Id : DataCore.Executive.LogMessageId
TimeStamp : 8/16/2011 10:08:11 AM
MachineName : SSV1
Level : Warning
Visibility : Customer
HighPriority : False
NeedsAcknowledge : False
MessageText : Failure status of {0} changed to {1}.
MessageData : {Virtual disk 4 on SSV1, No disk access}
UserId :
UserName :
Caller : LogicalDisk.UpdateCoreLogicalDiskData
Sources : {LD:84972D6B-7E71-4616-BDA1-57ECEAF3FFC4_V.{ea7c7a80-bdf3-11e0-8304-00155d11e921}-00000030, a18dea18ed93428a8951afa75ef6792f}
     
Id : DataCore.Executive.LogMessageId
TimeStamp : 8/16/2011 10:08:08 AM
MachineName : SSV1
Level : Warning
Visibility : Customer
HighPriority : False
NeedsAcknowledge : False
MessageText : Failure status of {0} changed to {1}.
MessageData : {Virtual disk 3 on SSV1, No disk access}
UserId :
UserName :
Caller : LogicalDisk.UpdateCoreLogicalDiskData
Sources : {LD:84972D6B-7E71-4616-BDA1-57ECEAF3FFC4_V.{ea7c7a80-bdf3-11e0-8304-00155d11e921}-0000002F, 635134ab2cad4b5d81af73ae5f09bd6f}
     
Id : DataCore.Executive.LogMessageId
TimeStamp : 8/16/2011 10:07:34 AM
MachineName : SSV1
Level : Warning
Visibility : Customer
HighPriority : False
NeedsAcknowledge : False
MessageText : Failure status of {0} changed to {1}.
MessageData : {Virtual disk 2 on SSV2, No disk access}
UserId :
UserName :
Caller : LogicalDisk.UpdateCoreLogicalDiskData
Sources : {LD:C553D471-3527-47EC-9326-D53E04204F2B_V.{315f03ec-bdf5-11e0-9dc3-00155d11e923}-0000002B, a6c21da23ec84baa80ab6a5c8c8c605c}
     
Id : DataCore.Executive.LogMessageId
TimeStamp : 8/16/2011 10:07:34 AM
MachineName : SSV1
Level : Warning
Visibility : Customer
HighPriority : False
NeedsAcknowledge : False
MessageText : Failure status of {0} changed to {1}.
MessageData : {Virtual disk 2 on SSV1, No disk access}
UserId :
UserName :
Caller : LogicalDisk.UpdateCoreLogicalDiskData
Sources : {LD:84972D6B-7E71-4616-BDA1-57ECEAF3FFC4_V.{ea7c7a80-bdf3-11e0-8304-00155d11e921}-0000002E, a6c21da23ec84baa80ab6a5c8c8c605c}
     

-------------- Example 2 Returns all messages of a specified source type with a specified level and higher --------------

Get-DcsLogMessage -Level Warning -SourceType "VirtualDisks"

Returns all log messages with a source type of "VirtualDisks" that are a level of Warning or higher (Warning, Error, or Diagnostic). In this case there are two messages that satisfy the parameters.

Id : DataCore.Executive.LogMessageId
TimeStamp : 8/15/2011 5:14:14 PM
MachineName : SSV1
Level : Warning
Visibility : Customer
HighPriority : True
NeedsAcknowledge : False
MessageText : Failed to create paths between the port(s) on Host3 and the port(s) on SSV2.
The possible reason : No free connection is available between the chosen initiator and target ports.
MessageData :
UserId :
UserName :
Caller : StorageServices.ServeVirtualDiskToNexus
Sources : {0dc5596489cb4d8ba0346f80eb47ad46}
     
Id : DataCore.Executive.LogMessageId
TimeStamp : 8/15/2011 5:13:12 PM
MachineName : SSV1
Level : Warning
Visibility : Customer
HighPriority : False
NeedsAcknowledge : False
MessageText : Failure status of {0} changed to {1}.
MessageData : {Virtual disk 1 on SSV1, No disk access}
UserId :
UserName :
Caller : LogicalDisk.UpdateCoreLogicalDiskData
Sources : {LD:84972D6B-7E71-4616-BDA1-57ECEAF3FFC4_V.{ea7c7a80-bdf3-11e0-8304-00155d11e921}-0000002D, 0dc5596489cb4d8ba0346f80eb47ad46}
     

To Table of Contents

NAME

Get-DcsLogStore

SYNOPSIS

Returns the logstore pool for a specified server.

SYNTAX

Get-DcsLogStore   -Server <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns the logstore pool for a specified server.

PARAMETERS

-Server<Object>
ServerHostData object, computer name or ID that identifies the server. The computer name must be unique or the name must be fully qualified.

Required: true
Position: 1
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

ServerHostData : Object that identifies and describes the server.

OUTPUTS

DiskPoolData : Object that identifies and describes the pool.

NOTES

Also see Set-DcsServerProperties to set the logstore pool for a server.

EXAMPLES

-------------- Example 1 Returns the logstore pool for a specified server. --------------

Get-DcsLogStore -Server SSVVM04

The cmdlet Get-DcsLogStore is invoked to return the logstore pool for the server named "SSVVM04". The DiskPoolData object is returned.


To Table of Contents

NAME

Get-DcsMirror

SYNOPSIS

Returns mirror data for mirrored virtual disks.

SYNTAX

Get-DcsMirror   [ -VirtualDisk <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns mirror data for mirrored virtual disks. Filtering parameters may be specified to narrow the scope of the data returned. If no parameters are specified, mirror data will be returned for all servers in the default connection.

PARAMETERS

-VirtualDisk<Object>
VirtualDiskData object, name, or ID that identifies a virtual disk. If specified, only data for the designated virtual disk will be returned.

Required: false
Position: 1
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

VirtualDiskData : Object that identifies and describes the virtual disk.

OUTPUTS

MirrorData : Object that identifies and describes a mirror.

NOTES

Also see Get-DcsVirtualDisk, Get-DcsLogicalDisk.

EXAMPLES

-------------- Example 1 Returns data for a virtual disk specified by name --------------

Get-DcsMirror -VirtualDisk "Virtual disk 1"

Returns data for the virtual disk named "Virtual disk 1".

FirstMirrorDiskId : V.{315f03ec-bdf5-11e0-9dc3-00155d11e923}-0000002A_N.22430030D9D4116D
SecondMirrorDiskId : V.{ea7c7a80-bdf3-11e0-8304-00155d11e921}-0000002D_N.22280030D9A5FE65
FirstLogicalDiskId : LD:84972D6B-7E71-4616-BDA1-57ECEAF3FFC4_V.{ea7c7a80-bdf3-11e0-8304-00155d11e921}-0000002D
SecondLogicalDiskId : LD:C553D471-3527-47EC-9326-D53E04204F2B_V.{315f03ec-bdf5-11e0-9dc3-00155d11e923}-0000002A
FirstRecovery : NoRecoveryNeeded
SecondRecovery : NoRecoveryNeeded
Id : LD:84972D6B-7E71-4616-BDA1-57ECEAF3FFC4_V.{ea7c7a80-bdf3-11e0-8304-00155d11e921}-0000002D|LD:C553
Caption : Virtual disk 1 on SSV1 - Virtual disk 1 on SSV2
ExtendedCaption : Virtual disk 1 on SSV1 - Virtual disk 1 on SSV2
Internal : False
     

To Table of Contents

NAME

Get-DcsMonitor

SYNOPSIS

Returns data for system monitors. Numerous system monitors gather and report status information for managed SAN resources.

SYNTAX

Get-DcsMonitor   [ -Object <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Get-DcsMonitor   [ -Monitor <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns data for system monitors. Numerous system monitors gather and report status information for managed SAN resources. Filtering parameters may be specified to narrow the scope of the data returned. If no parameters are specified, all monitors for all resources for the default connection will be returned.

PARAMETERS

-Object<Object>
The ID or object that identifies the resource to monitor. If specified, all monitors for the resource will be returned. For example, to return all monitors for a specific pool, pipe in the DiskPoolData object for that pool (see Example 3) or provide the ID as the parameter value.

Required: false
Position: 1
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Monitor<Object>
MonitorData object, name, or ID that identifies a monitor. If specified, only data for the designated monitor will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

MonitorData : Object that identifies and describes the monitor and the resource being monitored.

OUTPUTS

MonitorData : Object that identifies and describes the monitor and the resource being monitored. An object will be returned for each resource that is being monitored.

NOTES

Also see Get-DcsMonitorTemplate, Get-DcsTrigger.

EXAMPLES

-------------- Example 1 Returns monitors with selected states by piping objects --------------

Get-DcsMonitor | where {$_.State -ne "Healthy" -and $_.State -ne "Undefined"}

Returns all monitors in the server group with the exception of Healthy and Undefined, resulting in all monitors with a status of Critical, Warning, and Attention.

TemplateId : T(DataCore.Executive.Controller.ScsiPortConnectionStateMonitor<DataCore.Executive.Controller.ScsiPort>)
MonitoredObjectId : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3:MAC:00-15-5D-11-E9-0F
Description : Monitors the connection state of SCSI ports.
State : Attention
StateMessage : DataCore.Executive.LogMessage
Id : ScsiPortConnectionStateMonitor<A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3:MAC:00-15-5D-11-E9-0F>
Caption : Connection State
ExtendedCaption : Connection State
Internal : False
     
TemplateId : T(DataCore.Executive.Controller.PoolMemberStateMonitor<DataCore.Executive.Controller.PoolMember>)
MonitoredObjectId : 20394e04-6134-4ddf-8663-1176e851d27d
Description : Monitors the state of the relation between a pair of mirrored physical disks in a pool.
State : Attention
StateMessage : DataCore.Executive.LogMessage
Id : PoolMemberStateMonitor<20394e04-6134-4ddf-8663-1176e851d27d>
Caption : State
ExtendedCaption : State
Internal : False
     
TemplateId : T(DataCore.Executive.Controller.PoolMemberStateMonitor<DataCore.Executive.Controller.PoolMember>)
MonitoredObjectId : a32310da-9e33-43e6-85ec-6d45139d4965
Description : Monitors the state of the relation between a pair of mirrored physical disks in a pool.
State : Attention
StateMessage : DataCore.Executive.LogMessage
Id : PoolMemberStateMonitor<a32310da-9e33-43e6-85ec-6d45139d4965>
Caption : State
ExtendedCaption : State
Internal : False
     

-------------- Example 2 Returns a specific monitor for a specific virtual disk --------------

$VD1 = Get-DcsVirtualDisk -VirtualDisk "Virtual disk 1"

Get-DcsMonitor | where {$_.MonitoredObjectId -eq $VD1.Id}

Get-DcsMonitor | where {$_.MonitoredObjectId -eq $VD1.Id -and $_.TemplateID -match "VirtualDiskDataStatusMonitor"}

In this example, a series of cmdlet invocations is used to single out a specific monitor for a virtual disk. First, Get-DcsVirtualDisk is invoked with "Virtual disk 1" specified and the resulting VirtualDiskDataObject is stored in the variable $VD1. Next, the Get-DcsMonitor is invoked to return the MonitorData objects where the MonitoredObjectId is equal to the ID in the variable $VD1. In this case, two objects are returned (see the first two objects below). But the only MonitorData object desired is the VirtualDiskDataStatus Monitor, which monitors the status of "Virtual disk 1". So the Get-DcsMonitor cmdlet is invoked again to return the specific MonitorData object that is used to monitor the status of "Virtual disk 1". (See the third object below). The monitor name is included in the TemplateId of the MonitorData object. This method of retrieving a subset of MonitorData objects and then further filtering to pinpoint a specific object will save time due to the large number of monitors used in the system. 
MonitorData objects can be used to create a task trigger for a monitor state change, see Add-DcsTrigger.
TemplateId : T(DataCore.Executive.Controller.VirtualDiskDataStatusMonitor<DataCore.Executive.Controller.VirtualDisk>)
MonitoredObjectId : 40199f677a87440b8a845eb964f90fdb
Description : Monitors the data status of virtual disks.
State : Healthy
TimeStamp : 9/12/2014 10:46:19 AM
MessageText : Up to date
SequenceNumber : 5701
Id : VirtualDiskDataStatusMonitor<40199f677a87440b8a845eb964f90fdb>
Caption : Data Status
ExtendedCaption : Data Status of Virtual disk 1 from Server Group
Internal : False
     
TemplateId : T(DataCore.Executive.Controller.VirtualDiskAccessRightsMonitor<DataCore.Executive.Controller.VirtualDisk>)
MonitoredObjectId : 40199f677a87440b8a845eb964f90fdb
Description : Monitors the access rights of virtual disks.
State : Healthy
TimeStamp : 9/12/2014 10:34:30 AM
MessageText : Read/Write
SequenceNumber : 5553
Id : VirtualDiskAccessRightsMonitor<40199f677a87440b8a845eb964f90fdb>
Caption : Host Access
ExtendedCaption : Host Access of Virtual disk 1 from Server Group
Internal : False
     
     
     
TemplateId : T(DataCore.Executive.Controller.VirtualDiskDataStatusMonitor<DataCore.Executive.Controller.VirtualDisk>)
MonitoredObjectId : 40199f677a87440b8a845eb964f90fdb
Description : Monitors the data status of virtual disks.
State : Healthy
TimeStamp : 9/12/2014 10:46:19 AM
MessageText : Up to date
SequenceNumber : 5701
Id : VirtualDiskDataStatusMonitor<40199f677a87440b8a845eb964f90fdb>
Caption : Data Status
ExtendedCaption : Data Status of Virtual disk 1 from Server Group
Internal : False
     

-------------- Example 3 Returns all monitors for a specific object. --------------

Get-DcsPool -Server SSV1 -Pool "Disk pool 1" | Get-DcsMonitor

The cmdlet Get-DcsPool is invoked to return the DiskPoolData object for the pool "Disk pool 1" on server SSV1. That object is piped to the cmdlet Get-DcsMonitor and all monitors for that object are returned.

TemplateId : T(DataCore.Executive.Controller.DiskPoolStateMonitor<DataCore.Executive.Controller.DiskPool>)
MonitoredObjectId : 1B3541A1-752C-485E-B729-CB47CE559886:{fefed4a4-39ab-11e4-9ab1-00155d651603}
Description : Monitors the state of disk pools.
State : Healthy
TimeStamp : 9/12/2014 10:43:23 AM
MessageText : Running
SequenceNumber : 5674
Id : DiskPoolStateMonitor<1B3541A1-752C-485E-B729-CB47CE559886:{fefed4a4-39ab-11e4-9ab1-00155d651603}>
Caption : State
ExtendedCaption : State of Disk pool 1 on SSV1
Internal : False
     
TemplateId : T(DataCore.Executive.Controller.FallingThresholdPerfMonitor`1[T]<1B3541A1-752C-485E-B729-CB47CE559886:{fefed4a4-39ab-11e4-9ab1-00155d651603
MonitoredObjectId : 1B3541A1-752C-485E-B729-CB47CE559886:{fefed4a4-39ab-11e4-9ab1-00155d651603}
Description : Monitors the disk pools available space percentage.
State : Healthy
TimeStamp : 9/11/2014 10:41:16 AM
MessageText : Available space > 30%
SequenceNumber : 5038
Id : FallingThresholdPerfMonitor`1<1B3541A1-752C-485E-B729-CB47CE559886:{fefed4a4-39ab-11e4-9ab1-00155d651603}>PercentAvailable
Caption : Available space
ExtendedCaption : Available space of Disk pool 1 on SSV1
Internal : False
     
TemplateId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<1B3541A1-752C-485E-B729-CB47CE559886:{fefed4a4-39ab-11e4-9ab1-00155d651603}
MonitoredObjectId : 1B3541A1-752C-485E-B729-CB47CE559886:{fefed4a4-39ab-11e4-9ab1-00155d651603}
Description : Monitors the disk pools latency.
State : Healthy
TimeStamp : 9/11/2014 10:41:16 AM
MessageText : I/O latency < 5s
SequenceNumber : 5039
Id : RisingThresholdPerfMonitor`1<1B3541A1-752C-485E-B729-CB47CE559886:{fefed4a4-39ab-11e4-9ab1-00155d651603}>MaxReadWriteTime
Caption : I/O latency
ExtendedCaption : I/O latency of Disk pool 1 on SSV1
Internal : False
     

To Table of Contents

NAME

Get-DcsMonitorTemplate

SYNOPSIS

Returns templates for all system monitor types.

SYNTAX

Get-DcsMonitorTemplate   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns templates for all system monitor types. One object will be returned for every type of monitor template. This cmdlet can be used to identify a monitor template type ID for the Get-DcsTrigger cmdlet.

PARAMETERS

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

MonitorTemplateData : Object that identifies and describes a monitor template type.

NOTES

Also see Get-DcsMonitor, Get-DcsTrigger.

EXAMPLES

-------------- Example 1 Returns all monitor template types --------------

Get-DcsMonitorTemplate

Returns all templates for all monitor types.

MonitoredObjectId :
Alias : State
Description : Monitors the state of physical disks.
MonitorType : DataCore.Executive.Controller.PhysicalDiskStateMonitor
MonitoredObjectType : DataCore.Executive.Controller.PhysicalDisk
TypeId : T(DataCore.Executive.Controller.PhysicalDiskStateMonitor<DataCore.Executive.Controller.PhysicalDisk>)
SequenceNumber : 4672
Id : T(DataCore.Executive.Controller.PhysicalDiskStateMonitor<DataCore.Executive.Controller.PhysicalDisk>)
Caption : State
ExtendedCaption : State of Physical Disks
Internal : False
     
MonitoredObjectId :
Alias : Battery Power State
Description : Monitors the battery power state for DataCore Servers.
MonitorType : DataCore.Executive.Controller.ServerMachinePowerStateMonitor
MonitoredObjectType : DataCore.Executive.Controller.ServerMachine
TypeId : T(DataCore.Executive.Controller.ServerMachinePowerStateMonitor<DataCore.Executive.Controller.ServerMachine>)
SequenceNumber : 4701
Id : T(DataCore.Executive.Controller.ServerMachinePowerStateMonitor<DataCore.Executive.Controller.ServerMachine>)
Caption : Battery Power State
ExtendedCaption : Battery Power State of DataCore Servers
Internal : False
     
MonitoredObjectId :
Alias : License Expiration
Description : Monitors the license expiration date of DataCore Servers.
MonitorType : DataCore.Executive.Controller.ServerMachineLicenseMonitor
MonitoredObjectType : DataCore.Executive.Controller.ServerMachine
TypeId : T(DataCore.Executive.Controller.ServerMachineLicenseMonitor<DataCore.Executive.Controller.ServerMachine>)
SequenceNumber : 4702
Id : T(DataCore.Executive.Controller.ServerMachineLicenseMonitor<DataCore.Executive.Controller.ServerMachine>)
Caption : License Expiration
ExtendedCaption : License Expiration of DataCore Servers
Internal : False
     
MonitoredObjectId :
Alias : State
Description : Monitors the state of DataCore Servers.
MonitorType : DataCore.Executive.Controller.ServerMachineStateMonitor
MonitoredObjectType : DataCore.Executive.Controller.ServerMachine
TypeId : T(DataCore.Executive.Controller.ServerMachineStateMonitor<DataCore.Executive.Controller.ServerMachine>)
SequenceNumber : 4703
Id : T(DataCore.Executive.Controller.ServerMachineStateMonitor<DataCore.Executive.Controller.ServerMachine>)
Caption : State
ExtendedCaption : State of DataCore Servers
Internal : False
     
MonitoredObjectId :
Alias : VimHostConnectionStateMonitor
Description :
MonitorType : DataCore.Executive.Controller.VimHostConnectionStateMonitor
MonitoredObjectType : DataCore.Executive.Controller.VimHost
TypeId : T(DataCore.Executive.Controller.VimHostConnectionStateMonitor<DataCore.Executive.Controller.VimHost>)
SequenceNumber : 4704
Id : T(DataCore.Executive.Controller.VimHostConnectionStateMonitor<DataCore.Executive.Controller.VimHost>)
Caption : VimHostConnectionStateMonitor
ExtendedCaption : VimHostConnectionStateMonitor of DataCore.Executive.Controller.VimHost
Internal : False
     
MonitoredObjectId :
Alias : VimVirtualMachinePowerStateMonitor
Description :
MonitorType : DataCore.Executive.Controller.VimVirtualMachinePowerStateMonitor
MonitoredObjectType : DataCore.Executive.Controller.VimVirtualMachine
TypeId : T(DataCore.Executive.Controller.VimVirtualMachinePowerStateMonitor<DataCore.Executive.Controller.VimVirtualMachine>)
SequenceNumber : 4705
Id : T(DataCore.Executive.Controller.VimVirtualMachinePowerStateMonitor<DataCore.Executive.Controller.VimVirtualMachine>)
Caption : VimVirtualMachinePowerStateMonitor
ExtendedCaption : VimVirtualMachinePowerStateMonitor of DataCore.Executive.Controller.VimVirtualMachine
Internal : False
     
MonitoredObjectId :
Alias : State
Description : Monitors the state of MS iSCSI Initiator ports.
MonitorType : DataCore.Executive.Controller.ServerMSiScsiInitiatorStateMonitor
MonitoredObjectType : DataCore.Executive.Controller.ServerMSiScsiInitiator
TypeId : T(DataCore.Executive.Controller.ServerMSiScsiInitiatorStateMonitor<DataCore.Executive.Controller.ServerMSiScsiInitiator>)
SequenceNumber : 4706
Id : T(DataCore.Executive.Controller.ServerMSiScsiInitiatorStateMonitor<DataCore.Executive.Controller.ServerMSiScsiInitiator>)
Caption : State
ExtendedCaption : State of Server Microsoft iSCSI Initiator Ports
Internal : False
     
MonitoredObjectId :
Alias : State
Description : Monitors the state of the relation between a pair of mirrored physical disks in a pool.
MonitorType : DataCore.Executive.Controller.PoolMemberStateMonitor
MonitoredObjectType : DataCore.Executive.Controller.PoolMember
TypeId : T(DataCore.Executive.Controller.PoolMemberStateMonitor<DataCore.Executive.Controller.PoolMember>)
SequenceNumber : 4707
Id : T(DataCore.Executive.Controller.PoolMemberStateMonitor<DataCore.Executive.Controller.PoolMember>)
Caption : State
ExtendedCaption : State of Poo Mirror Disks
Internal : False
     
MonitoredObjectId :
Alias : Data Status
Description : Monitors the data status of virtual disk sources.
MonitorType : DataCore.Executive.Controller.LogicalDiskDataStatusMonitor
MonitoredObjectType : DataCore.Executive.Controller.LogicalDisk
TypeId : T(DataCore.Executive.Controller.LogicalDiskDataStatusMonitor<DataCore.Executive.Controller.LogicalDisk>)
SequenceNumber : 4708
Id : T(DataCore.Executive.Controller.LogicalDiskDataStatusMonitor<DataCore.Executive.Controller.LogicalDisk>)
Caption : Data Status
ExtendedCaption : Data Status of Virtual Disk Sources
Internal : False
     
MonitoredObjectId :
Alias : State
Description : Monitors the state of virtual disk sources.
MonitorType : DataCore.Executive.Controller.LogicalDiskStateMonitor
MonitoredObjectType : DataCore.Executive.Controller.LogicalDisk
TypeId : T(DataCore.Executive.Controller.LogicalDiskStateMonitor<DataCore.Executive.Controller.LogicalDisk>)
SequenceNumber : 4709
Id : T(DataCore.Executive.Controller.LogicalDiskStateMonitor<DataCore.Executive.Controller.LogicalDisk>)
Caption : State
ExtendedCaption : State of Virtual Disk Sources
Internal : False
     
MonitoredObjectId :
Alias : Failure Status
Description : Monitors the failure status of virtual disk sources.
MonitorType : DataCore.Executive.Controller.LogicalDiskFailureMonitor
MonitoredObjectType : DataCore.Executive.Controller.LogicalDisk
TypeId : T(DataCore.Executive.Controller.LogicalDiskFailureMonitor<DataCore.Executive.Controller.LogicalDisk>)
SequenceNumber : 4710
Id : T(DataCore.Executive.Controller.LogicalDiskFailureMonitor<DataCore.Executive.Controller.LogicalDisk>)
Caption : Failure Status
ExtendedCaption : Failure Status of Virtual Disk Sources
Internal : False
     
MonitoredObjectId :
Alias : Host Access
Description : Monitors the access rights of virtual disk sources.
MonitorType : DataCore.Executive.Controller.LogicalDiskAccessRightsMonitor
MonitoredObjectType : DataCore.Executive.Controller.LogicalDisk
TypeId : T(DataCore.Executive.Controller.LogicalDiskAccessRightsMonitor<DataCore.Executive.Controller.LogicalDisk>)
SequenceNumber : 4711
Id : T(DataCore.Executive.Controller.LogicalDiskAccessRightsMonitor<DataCore.Executive.Controller.LogicalDisk>)
Caption : Host Access
ExtendedCaption : Host Access of Virtual Disk Sources
Internal : False
     
MonitoredObjectId :
Alias : State
Description : Monitors the state of disk pools.
MonitorType : DataCore.Executive.Controller.DiskPoolStateMonitor
MonitoredObjectType : DataCore.Executive.Controller.DiskPool
TypeId : T(DataCore.Executive.Controller.DiskPoolStateMonitor<DataCore.Executive.Controller.DiskPool>)
SequenceNumber : 4712
Id : T(DataCore.Executive.Controller.DiskPoolStateMonitor<DataCore.Executive.Controller.DiskPool>)
Caption : State
ExtendedCaption : State of Disk Pools
Internal : False
     
MonitoredObjectId :
Alias : Continuous Data Protection State
Description : Monitors the state of the continuous data protection of virtual disk sources.
MonitorType : DataCore.Executive.Controller.StreamLogicalDiskStateMonitor
MonitoredObjectType : DataCore.Executive.Controller.StreamLogicalDisk
TypeId : T(DataCore.Executive.Controller.StreamLogicalDiskStateMonitor<DataCore.Executive.Controller.StreamLogicalDisk>)
SequenceNumber : 4719
Id : T(DataCore.Executive.Controller.StreamLogicalDiskStateMonitor<DataCore.Executive.Controller.StreamLogicalDisk>)
Caption : Continuous Data Protection State
ExtendedCaption : Continuous Data Protection State of Virtual Disk Sources with Continuous Data Protection
Internal : False
     
MonitoredObjectId :
Alias : Connection State
Description : Monitors the connection state of SCSI ports.
MonitorType : DataCore.Executive.Controller.ScsiPortConnectionStateMonitor
MonitoredObjectType : DataCore.Executive.Controller.ScsiPort
TypeId : T(DataCore.Executive.Controller.ScsiPortConnectionStateMonitor<DataCore.Executive.Controller.ScsiPort>)
SequenceNumber : 4720
Id : T(DataCore.Executive.Controller.ScsiPortConnectionStateMonitor<DataCore.Executive.Controller.ScsiPort>)
Caption : Connection State
ExtendedCaption : Connection State of SCSI Ports
Internal : False
     
MonitoredObjectId :
Alias : Replication State
Description : Monitors the replication state of virtual disks.
MonitorType : DataCore.Executive.Controller.ReplicationNexusStateMonitor
MonitoredObjectType : DataCore.Executive.Controller.ReplicationNexusBase
TypeId : T(DataCore.Executive.Controller.ReplicationNexusStateMonitor<DataCore.Executive.Controller.ReplicationNexusBase>)
SequenceNumber : 4721
Id : T(DataCore.Executive.Controller.ReplicationNexusStateMonitor<DataCore.Executive.Controller.ReplicationNexusBase>)
Caption : Replication State
ExtendedCaption : Replication State of Replication Nexus
Internal : False
     
MonitoredObjectId :
Alias : Link Errors
Description : Monitors the link errors on server ports.
MonitorType : DataCore.Executive.Controller.ServerPortLinkErrorMonitor
MonitoredObjectType : DataCore.Executive.Controller.ServerFcPort
TypeId : T(DataCore.Executive.Controller.ServerPortLinkErrorMonitor<DataCore.Executive.Controller.ServerFcPort>)
SequenceNumber : 4722
Id : T(DataCore.Executive.Controller.ServerPortLinkErrorMonitor<DataCore.Executive.Controller.ServerFcPort>)
Caption : Link Errors
ExtendedCaption : Link Errors of Server Fibre Ports
Internal : False
     
MonitoredObjectId :
Alias : State
Description : Monitors the state of server FC ports.
MonitorType : DataCore.Executive.Controller.ServerFcPortStateMonitor
MonitoredObjectType : DataCore.Executive.Controller.ServerFcPort
TypeId : T(DataCore.Executive.Controller.ServerFcPortStateMonitor<DataCore.Executive.Controller.ServerFcPort>)
SequenceNumber : 4723
Id : T(DataCore.Executive.Controller.ServerFcPortStateMonitor<DataCore.Executive.Controller.ServerFcPort>)
Caption : State
ExtendedCaption : State of Server Fibre Ports
Internal : False
     
MonitoredObjectId :
Alias : State
Description : Monitors the state of the relation between a virtual disk and its rollback
MonitorType : DataCore.Executive.Controller.RollbackRelationStateMonitor
MonitoredObjectType : DataCore.Executive.Controller.RollbackRelation
TypeId : T(DataCore.Executive.Controller.RollbackRelationStateMonitor<DataCore.Executive.Controller.RollbackRelation>)
SequenceNumber : 4724
Id : T(DataCore.Executive.Controller.RollbackRelationStateMonitor<DataCore.Executive.Controller.RollbackRelation>)
Caption : State
ExtendedCaption : State of DataCore.Executive.Controller.RollbackRelation
Internal : False
     
MonitoredObjectId :
Alias : State
Description : Monitors the state of snapshot relations.
MonitorType : DataCore.Executive.Controller.SnapshotRelationStateMonitor
MonitoredObjectType : DataCore.Executive.Controller.SnapshotRelation
TypeId : T(DataCore.Executive.Controller.SnapshotRelationStateMonitor<DataCore.Executive.Controller.SnapshotRelation>)
SequenceNumber : 4725
Id : T(DataCore.Executive.Controller.SnapshotRelationStateMonitor<DataCore.Executive.Controller.SnapshotRelation>)
Caption : State
ExtendedCaption : State of Snapshot Relations
Internal : False
     
MonitoredObjectId :
Alias : State
Description : Monitors the state of remote virtual disks.
MonitorType : DataCore.Executive.Controller.VirtualDiskProxyStateMonitor
MonitoredObjectType : DataCore.Executive.Controller.VirtualDiskProxy
TypeId : T(DataCore.Executive.Controller.VirtualDiskProxyStateMonitor<DataCore.Executive.Controller.VirtualDiskProxy>)
SequenceNumber : 4726
Id : T(DataCore.Executive.Controller.VirtualDiskProxyStateMonitor<DataCore.Executive.Controller.VirtualDiskProxy>)
Caption : State
ExtendedCaption : State of Remote Virtual Disks
Internal : False
     
MonitoredObjectId :
Alias : State
Description : Monitors the state of hosts.
MonitorType : DataCore.Executive.Controller.ClientMachineStateMonitor
MonitoredObjectType : DataCore.Executive.Controller.ClientMachine
TypeId : T(DataCore.Executive.Controller.ClientMachineStateMonitor<DataCore.Executive.Controller.ClientMachine>)
SequenceNumber : 4727
Id : T(DataCore.Executive.Controller.ClientMachineStateMonitor<DataCore.Executive.Controller.ClientMachine>)
Caption : State
ExtendedCaption : State of Hosts
Internal : False
     
MonitoredObjectId :
Alias : State
Description : Monitors the replication state of remote virtual disks.
MonitorType : DataCore.Executive.Controller.ReplicationNexusProxyStateMonitor
MonitoredObjectType : DataCore.Executive.Controller.ReplicationNexusProxy
TypeId : T(DataCore.Executive.Controller.ReplicationNexusProxyStateMonitor<DataCore.Executive.Controller.ReplicationNexusProxy>)
SequenceNumber : 4728
Id : T(DataCore.Executive.Controller.ReplicationNexusProxyStateMonitor<DataCore.Executive.Controller.ReplicationNexusProxy>)
Caption : State
ExtendedCaption : State of DataCore.Executive.Controller.ReplicationNexusProxy
Internal : False
     
MonitoredObjectId :
Alias : Host Access
Description : Monitors the access rights of virtual disks.
MonitorType : DataCore.Executive.Controller.VirtualDiskAccessRightsMonitor
MonitoredObjectType : DataCore.Executive.Controller.VirtualDisk
TypeId : T(DataCore.Executive.Controller.VirtualDiskAccessRightsMonitor<DataCore.Executive.Controller.VirtualDisk>)
SequenceNumber : 4729
Id : T(DataCore.Executive.Controller.VirtualDiskAccessRightsMonitor<DataCore.Executive.Controller.VirtualDisk>)
Caption : Host Access
ExtendedCaption : Host Access of Virtual Disks
Internal : False
     
MonitoredObjectId :
Alias : Data Status
Description : Monitors the data status of virtual disks.
MonitorType : DataCore.Executive.Controller.VirtualDiskDataStatusMonitor
MonitoredObjectType : DataCore.Executive.Controller.VirtualDisk
TypeId : T(DataCore.Executive.Controller.VirtualDiskDataStatusMonitor<DataCore.Executive.Controller.VirtualDisk>)
SequenceNumber : 4730
Id : T(DataCore.Executive.Controller.VirtualDiskDataStatusMonitor<DataCore.Executive.Controller.VirtualDisk>)
Caption : Data Status
ExtendedCaption : Data Status of Virtual Disks
Internal : False
     
MonitoredObjectId :
Alias : State
Description : Monitor the state of remote DataCore Servers.
MonitorType : DataCore.Executive.Controller.ServerMachineProxyStateMonitor
MonitoredObjectType : DataCore.Executive.Controller.ServerMachineProxy
TypeId : T(DataCore.Executive.Controller.ServerMachineProxyStateMonitor<DataCore.Executive.Controller.ServerMachineProxy>)
SequenceNumber : 4731
Id : T(DataCore.Executive.Controller.ServerMachineProxyStateMonitor<DataCore.Executive.Controller.ServerMachineProxy>)
Caption : State
ExtendedCaption : State of Replication Servers
Internal : False
     
MonitoredObjectId :
Alias : State
Description : Monitors the state of server iSCSI ports.
MonitorType : DataCore.Executive.Controller.ServeriScsiPortStateMonitor
MonitoredObjectType : DataCore.Executive.Controller.ServeriScsiPort
TypeId : T(DataCore.Executive.Controller.ServeriScsiPortStateMonitor<DataCore.Executive.Controller.ServeriScsiPort>)
SequenceNumber : 4732
Id : T(DataCore.Executive.Controller.ServeriScsiPortStateMonitor<DataCore.Executive.Controller.ServeriScsiPort>)
Caption : State
ExtendedCaption : State of Server iSCSI Ports
Internal : False
     
AttentionLevel : 30
WarningLevel : 20
CriticalLevel : 10
CounterName : PercentAvailable
Alias : Available space
Description : Monitors the disk pools available space percentage.
MonitorType : DataCore.Executive.Controller.FallingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.DiskPool
MonitoredObjectId : 1B3541A1-752C-485E-B729-CB47CE559886:{fefed4a4-39ab-11e4-9ab1-00155d651603}
TypeId : T(DataCore.Executive.Controller.FallingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.DiskPool>PercentAvailable)
SequenceNumber : 4713
Id : T(DataCore.Executive.Controller.FallingThresholdPerfMonitor`1[T]<1B3541A1-752C-485E-B729-CB47CE559886:{fefed4a4-39ab-11e4-9ab1-00155d6516 03}>PercentAvailable)
Caption : Available space
ExtendedCaption : Available space of 1B3541A1-752C-485E-B729-CB47CE559886:{fefed4a4-39ab-11e4-9ab1-00155d651603}
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the disk pools latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.DiskPool
MonitoredObjectId : 1B3541A1-752C-485E-B729-CB47CE559886:{fefed4a4-39ab-11e4-9ab1-00155d651603}
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.DiskPool>MaxReadWriteTime)
SequenceNumber : 4714
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<1B3541A1-752C-485E-B729-CB47CE559886:{fefed4a4-39ab-11e4-9ab1-00155d65160 3}>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of 1B3541A1-752C-485E-B729-CB47CE559886:{fefed4a4-39ab-11e4-9ab1-00155d651603}
Internal : False
     
AttentionLevel : 30
WarningLevel : 20
CriticalLevel : 10
CounterName : PercentAvailable
Alias : Available space
Description : Monitors the disk pools available space percentage.
MonitorType : DataCore.Executive.Controller.FallingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.DiskPool
MonitoredObjectId : 606E5C02-8C8A-4562-8AB0-2D4FC5A90B81:{1266fb4c-39ae-11e4-8cb7-00155d651607}
TypeId : T(DataCore.Executive.Controller.FallingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.DiskPool>PercentAvailable)
SequenceNumber : 4715
Id : T(DataCore.Executive.Controller.FallingThresholdPerfMonitor`1[T]<606E5C02-8C8A-4562-8AB0-2D4FC5A90B81:{1266fb4c-39ae-11e4-8cb7-00155d6516 07}>PercentAvailable)
Caption : Available space
ExtendedCaption : Available space of 606E5C02-8C8A-4562-8AB0-2D4FC5A90B81:{1266fb4c-39ae-11e4-8cb7-00155d651607}
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the disk pools latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.DiskPool
MonitoredObjectId : 606E5C02-8C8A-4562-8AB0-2D4FC5A90B81:{1266fb4c-39ae-11e4-8cb7-00155d651607}
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.DiskPool>MaxReadWriteTime)
SequenceNumber : 4716
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<606E5C02-8C8A-4562-8AB0-2D4FC5A90B81:{1266fb4c-39ae-11e4-8cb7-00155d65160 7}>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of 606E5C02-8C8A-4562-8AB0-2D4FC5A90B81:{1266fb4c-39ae-11e4-8cb7-00155d651607}
Internal : False
     
AttentionLevel : 30
WarningLevel : 20
CriticalLevel : 10
CounterName : PercentAvailable
Alias : Available space
Description : Monitors the disk pools available space percentage.
MonitorType : DataCore.Executive.Controller.FallingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.DiskPool
MonitoredObjectId : 1FB2747D-25E7-45D7-943C-3B203D9D88BE:{1c697e76-39b0-11e4-80cc-00155d651612}
TypeId : T(DataCore.Executive.Controller.FallingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.DiskPool>PercentAvailable)
SequenceNumber : 4717
Id : T(DataCore.Executive.Controller.FallingThresholdPerfMonitor`1[T]<1FB2747D-25E7-45D7-943C-3B203D9D88BE:{1c697e76-39b0-11e4-80cc-00155d6516 12}>PercentAvailable)
Caption : Available space
ExtendedCaption : Available space of 1FB2747D-25E7-45D7-943C-3B203D9D88BE:{1c697e76-39b0-11e4-80cc-00155d651612}
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the disk pools latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.DiskPool
MonitoredObjectId : 1FB2747D-25E7-45D7-943C-3B203D9D88BE:{1c697e76-39b0-11e4-80cc-00155d651612}
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.DiskPool>MaxReadWriteTime)
SequenceNumber : 4718
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<1FB2747D-25E7-45D7-943C-3B203D9D88BE:{1c697e76-39b0-11e4-80cc-00155d65161 2}>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of 1FB2747D-25E7-45D7-943C-3B203D9D88BE:{1c697e76-39b0-11e4-80cc-00155d651612}
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the shared physical disks latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.SharedPhysicalDisk
MonitoredObjectId : naa.60030d9013886301c6a4ada19eb953b4
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.SharedPhysicalDisk>MaxReadWriteTime)
SequenceNumber : 4733
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<naa.60030d9013886301c6a4ada19eb953b4>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of naa.60030d9013886301c6a4ada19eb953b4
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the shared physical disks latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.SharedPhysicalDisk
MonitoredObjectId : naa.60030d9048116401ccd351e4aeca7d48
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.SharedPhysicalDisk>MaxReadWriteTime)
SequenceNumber : 4734
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<naa.60030d9048116401ccd351e4aeca7d48>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of naa.60030d9048116401ccd351e4aeca7d48
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the shared physical disks latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.SharedPhysicalDisk
MonitoredObjectId : naa.60030d90a7c0e9034e3f2394bda58dbd
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.SharedPhysicalDisk>MaxReadWriteTime)
SequenceNumber : 4735
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<naa.60030d90a7c0e9034e3f2394bda58dbd>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of naa.60030d90a7c0e9034e3f2394bda58dbd
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the physical disks latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.PhysicalDisk
MonitoredObjectId : {9ab96746-21c8-4c7f-be71-c97d2f66cb66}
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.PhysicalDisk>MaxReadWriteTime)
SequenceNumber : 4674
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<{9ab96746-21c8-4c7f-be71-c97d2f66cb66}>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of {9ab96746-21c8-4c7f-be71-c97d2f66cb66}
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the physical disks latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.PhysicalDisk
MonitoredObjectId : {c164c16f-26eb-4d6a-b044-df6adff66b7d}
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.PhysicalDisk>MaxReadWriteTime)
SequenceNumber : 4675
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<{c164c16f-26eb-4d6a-b044-df6adff66b7d}>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of {c164c16f-26eb-4d6a-b044-df6adff66b7d}
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the physical disks latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.PhysicalDisk
MonitoredObjectId : {26e01911-9baa-47f4-a304-4cefd5f160e2}
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.PhysicalDisk>MaxReadWriteTime)
SequenceNumber : 4676
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<{26e01911-9baa-47f4-a304-4cefd5f160e2}>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of {26e01911-9baa-47f4-a304-4cefd5f160e2}
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the physical disks latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.PhysicalDisk
MonitoredObjectId : {c9e0e9a8-ff20-49b6-af10-c617cf1f5122}
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.PhysicalDisk>MaxReadWriteTime)
SequenceNumber : 4677
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<{c9e0e9a8-ff20-49b6-af10-c617cf1f5122}>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of {c9e0e9a8-ff20-49b6-af10-c617cf1f5122}
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the physical disks latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.PhysicalDisk
MonitoredObjectId : {483b113d-4fb2-4e70-9514-1ac6dce57e9e}
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.PhysicalDisk>MaxReadWriteTime)
SequenceNumber : 4678
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<{483b113d-4fb2-4e70-9514-1ac6dce57e9e}>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of {483b113d-4fb2-4e70-9514-1ac6dce57e9e}
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the physical disks latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.PhysicalDisk
MonitoredObjectId : {fc5cdc31-6bf9-4776-b53f-b5c20cc32eb6}
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.PhysicalDisk>MaxReadWriteTime)
SequenceNumber : 4679
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<{fc5cdc31-6bf9-4776-b53f-b5c20cc32eb6}>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of {fc5cdc31-6bf9-4776-b53f-b5c20cc32eb6}
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the physical disks latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.PhysicalDisk
MonitoredObjectId : {b534de77-64b9-4521-bcc8-08efa738206b}
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.PhysicalDisk>MaxReadWriteTime)
SequenceNumber : 4680
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<{b534de77-64b9-4521-bcc8-08efa738206b}>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of {b534de77-64b9-4521-bcc8-08efa738206b}
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the physical disks latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.PhysicalDisk
MonitoredObjectId : {527ca6d6-5d74-4ffa-83c8-7eebd945bf57}
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.PhysicalDisk>MaxReadWriteTime)
SequenceNumber : 4681
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<{527ca6d6-5d74-4ffa-83c8-7eebd945bf57}>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of {527ca6d6-5d74-4ffa-83c8-7eebd945bf57}
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the physical disks latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.PhysicalDisk
MonitoredObjectId : {36b544da-eb5e-47ff-ad27-c167db3ca8ac}
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.PhysicalDisk>MaxReadWriteTime)
SequenceNumber : 4696
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<{36b544da-eb5e-47ff-ad27-c167db3ca8ac}>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of {36b544da-eb5e-47ff-ad27-c167db3ca8ac}
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the physical disks latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.PhysicalDisk
MonitoredObjectId : {a4723a62-4ad8-4abd-b0fe-a26c22bf444f}
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.PhysicalDisk>MaxReadWriteTime)
SequenceNumber : 4697
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<{a4723a62-4ad8-4abd-b0fe-a26c22bf444f}>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of {a4723a62-4ad8-4abd-b0fe-a26c22bf444f}
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the physical disks latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.PhysicalDisk
MonitoredObjectId : {a74bef30-818f-417a-9554-fc6535e840b8}
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.PhysicalDisk>MaxReadWriteTime)
SequenceNumber : 4683
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<{a74bef30-818f-417a-9554-fc6535e840b8}>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of {a74bef30-818f-417a-9554-fc6535e840b8}
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the physical disks latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.PhysicalDisk
MonitoredObjectId : {888d81b5-d276-4c97-bd32-7ca6dd13cc1c}
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.PhysicalDisk>MaxReadWriteTime)
SequenceNumber : 4682
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<{888d81b5-d276-4c97-bd32-7ca6dd13cc1c}>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of {888d81b5-d276-4c97-bd32-7ca6dd13cc1c}
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the physical disks latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.PhysicalDisk
MonitoredObjectId : {335264af-710e-42df-b537-aa66adcc7d96}
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.PhysicalDisk>MaxReadWriteTime)
SequenceNumber : 4698
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<{335264af-710e-42df-b537-aa66adcc7d96}>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of {335264af-710e-42df-b537-aa66adcc7d96}
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the physical disks latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.PhysicalDisk
MonitoredObjectId : {715eb815-195b-4b4d-99cd-cac353475a30}
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.PhysicalDisk>MaxReadWriteTime)
SequenceNumber : 4699
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<{715eb815-195b-4b4d-99cd-cac353475a30}>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of {715eb815-195b-4b4d-99cd-cac353475a30}
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the physical disks latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.PhysicalDisk
MonitoredObjectId : {b185247e-0208-497b-9c31-d28be00e4603}
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.PhysicalDisk>MaxReadWriteTime)
SequenceNumber : 4700
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<{b185247e-0208-497b-9c31-d28be00e4603}>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of {b185247e-0208-497b-9c31-d28be00e4603}
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the physical disks latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.PhysicalDisk
MonitoredObjectId : {d4d2a1b7-f30c-4501-837a-0f82dd57dde3}
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.PhysicalDisk>MaxReadWriteTime)
SequenceNumber : 4690
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<{d4d2a1b7-f30c-4501-837a-0f82dd57dde3}>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of {d4d2a1b7-f30c-4501-837a-0f82dd57dde3}
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the physical disks latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.PhysicalDisk
MonitoredObjectId : {9c60527e-f7b0-4c43-9477-a20a38fcb516}
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.PhysicalDisk>MaxReadWriteTime)
SequenceNumber : 4689
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<{9c60527e-f7b0-4c43-9477-a20a38fcb516}>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of {9c60527e-f7b0-4c43-9477-a20a38fcb516}
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the physical disks latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.PhysicalDisk
MonitoredObjectId : {6b1e9aef-d326-4ff8-ae72-d134967ad536}
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.PhysicalDisk>MaxReadWriteTime)
SequenceNumber : 4688
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<{6b1e9aef-d326-4ff8-ae72-d134967ad536}>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of {6b1e9aef-d326-4ff8-ae72-d134967ad536}
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the physical disks latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.PhysicalDisk
MonitoredObjectId : {5121c850-eac3-4942-87ba-8060d0ce1889}
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.PhysicalDisk>MaxReadWriteTime)
SequenceNumber : 4687
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<{5121c850-eac3-4942-87ba-8060d0ce1889}>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of {5121c850-eac3-4942-87ba-8060d0ce1889}
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the physical disks latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.PhysicalDisk
MonitoredObjectId : {cea08013-4f71-40dd-af0e-fd57c20dbf93}
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.PhysicalDisk>MaxReadWriteTime)
SequenceNumber : 4686
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<{cea08013-4f71-40dd-af0e-fd57c20dbf93}>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of {cea08013-4f71-40dd-af0e-fd57c20dbf93}
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the physical disks latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.PhysicalDisk
MonitoredObjectId : {8fb6c5a7-67d5-4c8b-bb4d-4be2383f413f}
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.PhysicalDisk>MaxReadWriteTime)
SequenceNumber : 4685
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<{8fb6c5a7-67d5-4c8b-bb4d-4be2383f413f}>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of {8fb6c5a7-67d5-4c8b-bb4d-4be2383f413f}
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the physical disks latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.PhysicalDisk
MonitoredObjectId : V.{1266fb4c-39ae-11e4-8cb7-00155d651607}-00000001_N.228A0030D99902E2
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.PhysicalDisk>MaxReadWriteTime)
SequenceNumber : 4691
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<V.{1266fb4c-39ae-11e4-8cb7-00155d651607}-00000001_N.228A0030D99902E2>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of V.{1266fb4c-39ae-11e4-8cb7-00155d651607}-00000001_N.228A0030D99902E2
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the physical disks latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.PhysicalDisk
MonitoredObjectId : V.{fefed4a4-39ab-11e4-9ab1-00155d651603}-00000001_N.22C10030D9BD9800
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.PhysicalDisk>MaxReadWriteTime)
SequenceNumber : 4692
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<V.{fefed4a4-39ab-11e4-9ab1-00155d651603}-00000001_N.22C10030D9BD9800>MaxR eadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of V.{fefed4a4-39ab-11e4-9ab1-00155d651603}-00000001_N.22C10030D9BD9800
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the physical disks latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.PhysicalDisk
MonitoredObjectId : V.{1266fb4c-39ae-11e4-8cb7-00155d651607}-00000002_N.228A0030D99902E2
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.PhysicalDisk>MaxReadWriteTime)
SequenceNumber : 4693
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<V.{1266fb4c-39ae-11e4-8cb7-00155d651607}-00000002_N.228A0030D99902E2>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of V.{1266fb4c-39ae-11e4-8cb7-00155d651607}-00000002_N.228A0030D99902E2
Internal : False
     
AttentionLevel : 5000
WarningLevel : 10000
CriticalLevel : 30000
CounterName : MaxReadWriteTime
Alias : I/O latency
Description : Monitors the physical disks latency.
MonitorType : DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]
MonitoredObjectType : DataCore.Executive.Controller.PhysicalDisk
MonitoredObjectId : V.{fefed4a4-39ab-11e4-9ab1-00155d651603}-00000002_N.22C10030D9BD9800
TypeId : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<DataCore.Executive.Controller.PhysicalDisk>MaxReadWriteTime)
SequenceNumber : 4694
Id : T(DataCore.Executive.Controller.RisingThresholdPerfMonitor`1[T]<V.{fefed4a4-39ab-11e4-9ab1-00155d651603}-00000002_N.22C10030D9BD9800>MaxReadWriteTime)
Caption : I/O latency
ExtendedCaption : I/O latency of V.{fefed4a4-39ab-11e4-9ab1-00155d651603}-00000002_N.22C10030D9BD9800
Internal : False
     

To Table of Contents

NAME

Get-DcsObject

SYNOPSIS

Returns the identifiable object obtained by an ID.

SYNTAX

Get-DcsObject   -Id <String>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns the identifiable object obtained by an ID. This cmdlet can be used to get an object that is identified by ID within another object.

PARAMETERS

-Id<String>
The ID of any object or entity in the configuration

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

string : The ID of any resource used to obtain the identifiable object for the ID.

OUTPUTS

object : Any type of identifiable object.

NOTES

EXAMPLES

-------------- Example 1 Returns the objects for all resources that have monitor states other than "Healthy" or "Undefined". --------------

Get-DcsMonitor | where { $_.State -ne "Healthy" -and $_.State -ne "Undefined"} | foreach { $_.MonitoredObjectId } | Get-DcsObject

The cmdlet Get-DcsMonitor is invoked to get the MonitoredObjectId of all resources that do not have a state of "Healthy" or "Undefined". The MonitoredObjectId is piped to the cmdlet Get-DcsObject to return the identifiable objects for those resources. In this case there are two buffer folders that are not set for configured replications.

FirstServerId : 1749d66b-3a4c-4e92-936f-33e693173dd7:737B4128-2806-4C46-BA64-2409C345FE9D
FirstVirtualDiskId : aa0261e857e845faa6582272862944ce
SecondServerId : A3E78CFA-DBEC-44E1-A23C-E9E262EC4551
SecondVirtualDiskId : 55d09862519c4c279fbb0ce736ce4008
IsActiveSide : False
ReplicationState : Standby
FailureStatus : BufferFolderNotSet
TransferStatus : Enabled
Paused : False
CheckpointSnapshotId :
AutoAsyncReplicationLicense : Enabled
OfflineInitializationSupported : True
InitializationType : Online
OfflineInitializationBuffer :
OfflineInitStatus : NoOfflineInit
InitializationFailureStatus : NoFailure
TestModeStatus : Disabled
IsChangingBufferFolders : False
BackendStatus : NA
DuplicatedDiskId : False
SequenceNumber : 8230
Id : fa8837c6-7d16-4ba4-a040-4f6efb2fcf43
Caption : Virtual disk 2
ExtendedCaption : Virtual disk 2 from Group2
Internal : False
     
FirstServerId : 1749d66b-3a4c-4e92-936f-33e693173dd7:737B4128-2806-4C46-BA64-2409C345FE9D
FirstVirtualDiskId : 43c4d09b49d345f7af97e6ab36ed1d99
SecondServerId : A3E78CFA-DBEC-44E1-A23C-E9E262EC4551
SecondVirtualDiskId : bb559078535047789ced8db9f4b7f9a3
IsActiveSide : False
ReplicationState : Standby
FailureStatus : BufferFolderNotSet
TransferStatus : Enabled
Paused : False
CheckpointSnapshotId :
AutoAsyncReplicationLicense : Enabled
OfflineInitializationSupported : True
InitializationType : Online
OfflineInitializationBuffer :
OfflineInitStatus : NoOfflineInit
InitializationFailureStatus : NoFailure
TestModeStatus : Disabled
IsChangingBufferFolders : False
BackendStatus : NA
DuplicatedDiskId : False
SequenceNumber : 8231
Id : a0ab1dce-f06b-4e63-a489-b06d55ec0301
Caption : Virtual disk 1
ExtendedCaption : Virtual disk 1 from Group2
Internal : False
     

-------------- Example 2 Returns the objects for the servers that have alerts --------------

$Alert = Get-DcsAlert
$Alert[0].Id | Get-Member


   TypeName: DataCore.Executive.LogMessageId

Name           MemberType Definition
----           ---------- ----------
Equals         Method     bool Equals(System.Object obj)
GetHashCode    Method     int GetHashCode()
GetType        Method     type GetType()
LogicalEquals  Method     bool LogicalEquals(DataCore.Executive.LogMessageId id)
ToString       Method     string ToString()
MachineId      Property   string MachineId {get;set;}
SequenceNumber Property   uint64 SequenceNumber {get;set;}

Get-DcsAlert | foreach { $_.Id.MachineId } | Get-DcsObject

The cmdlet Get-DcsAlert is invoked to get the MachineId of all resources that have an alert. The MachineId is piped to the cmdlet Get-DcsObject to return the identifiable objects for those resources. In this case the alerts are for the machine named StorageSvr001.

GroupId : 4b428832-fd51-45df-9c21-ce267e1ceb7a
RegionNodeId : ExecutiveNode:A3E78CFA-DBEC-44E1-A23C-E9E262EC4551
CacheSize : 0 B
State : Online
SupportState : Idle
SnapshotMapStoreId :
SnapshotMapStorePoolId :
InstallPath : C:\Program Files\DataCore\SANsymphony
ProductName : DataCore SANsymphony
ProductType : Standard
ProductVersion : 10.0 PSP 3
OsVersion : Windows Server 2012 x64 Edition
ProcessorInfo : DataCore.Executive.ProcessorInformation
ProductBuild : 15.0.300.4633
BuildType : Release
DiagnosticMode : Enabled
LicenseRemaining : 9223372036854775807
ReplicationBufferFolder : R:
TotalSystemMemory : 3.00 GB
AvailableSystemMemory : 775.79 MB
LogStatus : Operational
LicenseSettings : DataCore.Executive.LicenseSettings
IsLicensed : True
LicenseExceeded : False
StorageUsed : 0 B
DataCoreStorageUsed : 50 GB
PowerState : ACOnline
CacheState : WritebackGlobal
BackupStorageFolder :
IpAddresses : {172.20.17.50, fe80::a84e:2f51:c1f2:a122, 13.0.0.31, 13.0.0.32...}
LicenseNumber : 2513008801887348963
AluaGroupId : 1
IsVirtualMachine : True
HypervisorHostId :
Description :
HostName : StorageSvr001.datacoresoftware.com
MpioCapable : True
SequenceNumber : 8232
Id : A3E78CFA-DBEC-44E1-A23C-E9E262EC4551
Caption : StorageSvr001
ExtendedCaption : StorageSvr001 in Group1
Internal : False
     
GroupId : 4b428832-fd51-45df-9c21-ce267e1ceb7a
RegionNodeId : ExecutiveNode:A3E78CFA-DBEC-44E1-A23C-E9E262EC4551
CacheSize : 0 B
State : Online
SupportState : Idle
SnapshotMapStoreId :
SnapshotMapStorePoolId :
InstallPath : C:\Program Files\DataCore\SANsymphony
ProductName : DataCore SANsymphony
ProductType : Standard
ProductVersion : 10.0 PSP 3
OsVersion : Windows Server 2012 x64 Edition
ProcessorInfo : DataCore.Executive.ProcessorInformation
ProductBuild : 15.0.300.4633
BuildType : Release
DiagnosticMode : Enabled
LicenseRemaining : 9223372036854775807
ReplicationBufferFolder : R:
TotalSystemMemory : 3.00 GB
AvailableSystemMemory : 775.79 MB
LogStatus : Operational
LicenseSettings : DataCore.Executive.LicenseSettings
IsLicensed : True
LicenseExceeded : False
StorageUsed : 0 B
DataCoreStorageUsed : 50 GB
PowerState : ACOnline
CacheState : WritebackGlobal
BackupStorageFolder :
IpAddresses : {172.20.17.50, fe80::a84e:2f51:c1f2:a122, 13.0.0.31, 13.0.0.32...}
LicenseNumber : 2513008801887348963
AluaGroupId : 1
IsVirtualMachine : True
HypervisorHostId :
Description :
HostName : StorageSvr001.datacoresoftware.com
MpioCapable : True
SequenceNumber : 8233
Id : A3E78CFA-DBEC-44E1-A23C-E9E262EC4551
Caption : StorageSvr001
ExtendedCaption : StorageSvr001 in Group1
Internal : False
     
GroupId : 4b428832-fd51-45df-9c21-ce267e1ceb7a
RegionNodeId : ExecutiveNode:A3E78CFA-DBEC-44E1-A23C-E9E262EC4551
CacheSize : 0 B
State : Online
SupportState : Idle
SnapshotMapStoreId :
SnapshotMapStorePoolId :
InstallPath : C:\Program Files\DataCore\SANsymphony
ProductName : DataCore SANsymphony
ProductType : Standard
ProductVersion : 10.0 PSP 3
OsVersion : Windows Server 2012 x64 Edition
ProcessorInfo : DataCore.Executive.ProcessorInformation
ProductBuild : 15.0.300.4633
BuildType : Release
DiagnosticMode : Enabled
LicenseRemaining : 9223372036854775807
ReplicationBufferFolder : R:
TotalSystemMemory : 3.00 GB
AvailableSystemMemory : 775.79 MB
LogStatus : Operational
LicenseSettings : DataCore.Executive.LicenseSettings
IsLicensed : True
LicenseExceeded : False
StorageUsed : 0 B
DataCoreStorageUsed : 50 GB
PowerState : ACOnline
CacheState : WritebackGlobal
BackupStorageFolder :
IpAddresses : {172.20.17.50, fe80::a84e:2f51:c1f2:a122, 13.0.0.31, 13.0.0.32...}
LicenseNumber : 2513008801887348963
AluaGroupId : 1
IsVirtualMachine : True
HypervisorHostId :
Description :
HostName : StorageSvr001.datacoresoftware.com
MpioCapable : True
SequenceNumber : 8234
Id : A3E78CFA-DBEC-44E1-A23C-E9E262EC4551
Caption : StorageSvr001
ExtendedCaption : StorageSvr001 in Group1
Internal : False
     
GroupId : 4b428832-fd51-45df-9c21-ce267e1ceb7a
RegionNodeId : ExecutiveNode:A3E78CFA-DBEC-44E1-A23C-E9E262EC4551
CacheSize : 0 B
State : Online
SupportState : Idle
SnapshotMapStoreId :
SnapshotMapStorePoolId :
InstallPath : C:\Program Files\DataCore\SANsymphony
ProductName : DataCore SANsymphony
ProductType : Standard
ProductVersion : 10.0 PSP 3
OsVersion : Windows Server 2012 x64 Edition
ProcessorInfo : DataCore.Executive.ProcessorInformation
ProductBuild : 15.0.300.4633
BuildType : Release
DiagnosticMode : Enabled
LicenseRemaining : 9223372036854775807
ReplicationBufferFolder : R:
TotalSystemMemory : 3.00 GB
AvailableSystemMemory : 775.79 MB
LogStatus : Operational
LicenseSettings : DataCore.Executive.LicenseSettings
IsLicensed : True
LicenseExceeded : False
StorageUsed : 0 B
DataCoreStorageUsed : 50 GB
PowerState : ACOnline
CacheState : WritebackGlobal
BackupStorageFolder :
IpAddresses : {172.20.17.50, fe80::a84e:2f51:c1f2:a122, 13.0.0.31, 13.0.0.32...}
LicenseNumber : 2513008801887348963
AluaGroupId : 1
IsVirtualMachine : True
HypervisorHostId :
Description :
HostName : StorageSvr001.datacoresoftware.com
MpioCapable : True
SequenceNumber : 8235
Id : A3E78CFA-DBEC-44E1-A23C-E9E262EC4551
Caption : StorageSvr001
ExtendedCaption : StorageSvr001 in Group1
Internal : False
     

-------------- Example 3 Returns the storage profile objects for the virtual disks served to specified machines (hosts) --------------

Get-DcsVirtualDisk -Machine "HostVM1", "HostVM2" | foreach { $_.StorageProfileId } | Get-DcsObject

The cmdlet Get-DcsVirtualDisk is used to get objects for all virtual disks served to the client hosts "HostVM1" and "HostVM2". Those objects are piped to Get-DcsObject to return the identifiable objects for each Storage Profile ID.

Alias : Normal
Description :
PerformanceClass : Normal
ReplicationPriority : Regular
RecoveryPriority : Regular
WriteTracking : False
DefaultProfile : True
SequenceNumber : 8238
Id : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
Caption : Normal
ExtendedCaption : Normal Profile
Internal : False
     
Alias : Normal
Description :
PerformanceClass : Normal
ReplicationPriority : Regular
RecoveryPriority : Regular
WriteTracking : False
DefaultProfile : True
SequenceNumber : 8239
Id : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
Caption : Normal
ExtendedCaption : Normal Profile
Internal : False
     
Alias : Normal
Description :
PerformanceClass : Normal
ReplicationPriority : Regular
RecoveryPriority : Regular
WriteTracking : False
DefaultProfile : True
SequenceNumber : 8240
Id : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
Caption : Normal
ExtendedCaption : Normal Profile
Internal : False
     
Alias : Normal
Description :
PerformanceClass : Normal
ReplicationPriority : Regular
RecoveryPriority : Regular
WriteTracking : False
DefaultProfile : True
SequenceNumber : 8241
Id : 100469DF-0BE1-40DA-874E-9F1DA5A259E3
Caption : Normal
ExtendedCaption : Normal Profile
Internal : False
     

To Table of Contents

NAME

Get-DcsPerformanceCounter

SYNOPSIS

Returns performance counter data for the specified object.

SYNTAX

Get-DcsPerformanceCounter   -Object <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns performance counter data for the specified object. Some counter values accumulate and some counter values are displayed as the value at collection time (CollectionTime field in the returned object, see example). The accumulated values in returned objects are raw, unprocessed data at collection time, not "per second" as displayed in the Management Console. For instance, to receive values per second the cmdlet would have to be invoked at least twice to calculate values per second. Descriptions of performance counters are provided as tool tips in the Performance tool in the DataCore Management Console. Some counters in the Performance tool are derived from raw data counters found in PerformanceData objects. Therefore, some raw data counters may not appear in the tool and some derived counters may not appear in retrieved PerformanceData objects. Special notes about these raw data counters are documented. For the Pool PerformanceData object: TotalWriteTime is a cumulative counter that measures the total time it took to perform all the write I/Os to the back-end pool disk. It is used to compute the Average Time/Write counter in the Performance tool. Average Time per Write = ∆ TotalWriteTime / ∆ TotalWrites. TotalReadTime is a cumulative counter that measures the total time it took to perform all read I/Os to the back-end pool disk. It is used to compute the Average Time/Read counter in the Performance tool. Average Time per Read = ∆ TotalReadTime / ∆ TotalReads.

PARAMETERS

-Object<Object>
Any object or ID that identifies one of the following object types: servers, server SCSI ports, server groups, client hosts, host groups, client host SCSI ports, physical disks, pool members, pools, pool mirrors, virtual disks, snapshots, logical disks, logical disks with Continuous Data Protection, virtual logical units, target devices, and target domains. Special Notes: To get performance counter data for a shared physical disk, provide the SharedPhysicalDiskData object; data will be aggregated from all servers sharing the physical disk. If the PhysicalDiskData object is provided for a shared physical disk, then the performance counter data returned will only be from one server. To get performance counter data for a shared disk pool, always provide the SharedDiskPoolData object for the pool.

Required: true
Position: 1
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

Object : Any object that has performance counters, used to identify the Object parameter.

OUTPUTS

PerformanceData : Object that describes the performance data for an object.

NOTES

To add counters to a recording session, see Add-DcsRecordingPoint. Also see Get-DcsRecordingInstance, Get-DcsRecordingPerformance, Get-DcsRecordingPoint, Get-DcsRecordingResolution, Get-DcsRecordingEndpoint, Get-DcsRecordingSession, Get-DcsRecordingStatistics

EXAMPLES

-------------- Example 1 Returns data for a specified SAN component by piping an object --------------

Get-DcsPool -Server SSV1 -Pool "Disk pool 1" | Get-DcsPerformanceCounter

The cmdlet Get-DcsPool is used to obtain the object for the pool named "Disk pool 1". The server "SSV1" must be specified because the same pool name exists on another server in the server group. The object is piped to Get-DcsPerformance to returns the Performance counter data for the pool "Disk pool 1" on server "SSV1". 
(In the example output, the collection time uses the UTC time standard.)
TotalBytesTransferred : 402739200
TotalBytesRead : 402739200
TotalBytesWritten : 0
TotalBytesMigrated : 0
TotalReads : 2607
TotalWrites : 0
TotalOperations : 2607
BytesAllocated : 402653184
BytesAvailable : 159584878592
BytesInReclamation : 0
BytesTotal : 159987531776
PercentAllocated : 0
PercentAvailable : 99
TotalReadTime : 226572
TotalWriteTime : 0
MaxReadTime : 0
MaxWriteTime : 0
MaxReadWriteTime : 0
MaxNumberChunks : 8290112
BytesReserved : 0
CollectionTime : 8/11/2011 3:16:29 PM
     

-------------- Example 2 Returns data for a specific counter in an object. --------------

Get-DcsLogicalDisk -VirtualDisk 'Virtual Disk 1' -Server SSV2 | Get-DcsPerformanceCounter | select-object BytesAllocated

The cmdlet Get-DcsLogicalDisk is used to obtain the LogicalDiskData object for the logical disk in "Virtual Disk 1" that resides on server "SSV2". This object is piped to Get-DcsPerformanceCounter to return the Bytes Allocated value for the logical disk on server "SSV2" within "Virtual Disk 1". The BytesAllocated member contains the amount of pool space allocated to Virtual Disk 1 on SSV2.

BytesAllocated
--------------
        4194304
                                

-------------- Example 3 Returns bytes allocated for all virtual disks in the server group in a text file --------------

$resultsLocation = "C:\"
$allocationResult = @()

foreach($vd in (Get-DcsVirtualDisk))
{
    $result = New-Object PSObject
    $result | Add-Member -MemberType NoteProperty -Name "Virtual Disk" -Value ($vd.Alias)
    $result | Add-Member -MemberType NoteProperty -Name "Allocation" -Value (($vd[0] | Get-DcsPerformanceCounter).BytesAllocated)
    $result | Add-Member -MemberType NoteProperty -Name "Size" -Value "Bytes"
    $allocationResult += $result
}

$allocationResult > $resultsLocation\allocation-results.txt

This is a script file which retrieves the number of allocated bytes for each virtual disk in the server group. A high level explanation follows. The number of allocated bytes is part of the performance data for the virtual disk. The cmdlet Get-DcsVirtualDisk is invoked to retrieve the virtual disk objects. The objects are passed to the cmdlet Get-DcsPerformanceCounter in order to get the count for BytesAllocated in the PerformanceData object. A custom object is created with the data returned from the cmdlets. The virtual disk name and allocation size are output to the file allocation-results.txt in the specified folder location.

Virtual Disk                        Allocation Size                                   
------------                        ---------- ----                                   
Virtual disk 1                     53284438016 Bytes                                  
Virtual disk 2                     30601641984 Bytes                                  
Virtual disk 3                     24293408768 Bytes                                  
Virtual disk 4                     24024973312 Bytes
                                

-------------- Example 4 Returns pool allocations for the server group --------------

$MB = 1024*1024
$Pools = Get-DcsPool
foreach($p in $Pools)
{
        Write-Host "Allocation for" $p.ExtendedCaption " = " $Alloc ($p | Get-DcsPerformanceCounter | % {$_.BytesAllocated/$MB}) "MB"
        Write-Host
}

This simple script file returns the allocations for each pool in the server group in megabytes. The cmdlet Get-DcsPool is used to get the DiskPoolData objects for all pools in the server group and assign to the variable $Pools. For each object in $Pools, the variable is used to output the name of the pool and is piped to the cmdlet Get-DcsPerformanceCounter. The returned performance data is used to get the bytes allocated for each pool. The bytes allocated is multiplied by 1024 * 1024 to get the number of megabytes allocated for each pool.

Allocation for Disk pool 1 on SSV1  =  1408 MB

Allocation for Shared pool 1 on SSV1  =  2176 MB

Allocation for Disk pool 2 on SSV2  =  896 MB

Allocation for Shared pool 1 on SSV2  =  2176 MB

Allocation for Disk pool 3 on SSV3  =  512 MB

Allocation for Shared pool 1 on SSV3  =  2176 MB
                                

-------------- Example 5 Returns performance metrics for physical disks in a specified pool. --------------

Get-DcsPoolMember -Pool "Disk pool 1" | Get-DcsPerformanceCounter

The cmdlet Get-DcsPoolMember is invoked to obtain the PoolMemberData object for the pool "Disk pool 1" and the results are piped to the cmdlet Get-DcsPerformanceCounter to retrieve the counters for the physical disk in the pool. In this case, there is one physical disk in the pool so one object is returned.

BytesAllocated : 268435456
BytesAvailable : 20803747840
BytesInReclamation : 0
BytesRecovered : 0
BytesRemainingToRecover : 0
BytesTotalToRecover : 0
BytesMigrated : 0
CollectionTime : 9/8/2015 8:18:16 PM
NullCounterMap : 0
     

-------------- Example 6 Get the current retention period when Continous Data Protection is enabled. --------------

Get-DcsLogicalDisk -VirtualDisk "Virtual Disk 1" -Server SSV2 | Get-DcsPerformanceCounter

To obtain the up-to-date retention period of a virtual disk with CDP, invoke the cmdlet Get-DcsLogicalDisk for the virtual disk "Virtual Disk 1" for the Server named "SSV2" and pipe the results to the cmdlet Get-DcsPerformanceCounter. The Retention Period is in milliseconds. 
The result of the following is in hours:
(Get-DcsLogicalDisk -VirtualDisk "[VIRTUAL DISK NAME]" -Server [DATACORE SERVER NAME] | Get-DcsPerformanceCounter).RetentionPeriod/(1000*60*60)
DestageTime : 63585965524000
StreamBytesCopied : 0
StreamBytesTotal : 1
StreamRevertOrDetachPercent : 0
StreamAllocationPercent : 1
RetentionPeriod : 85289386
BytesAllocated : 0
BytesMigrated : 0
BytesOutOfAffinity : 0
TotalBytesTransferred : 5632
TotalBytesRead : 5632
TotalBytesWritten : 0
TotalOperations : 4
TotalReads : 4
TotalWrites : 0
CacheReadHits : 4
CacheReadMisses : 0
CacheWriteHits : 0
CacheWriteMisses : 0
CacheReadHitBytes : 5632
CacheReadMissBytes : 0
CacheWriteHitBytes : 0
CacheWriteMissBytes : 0
PercentRecovered : 0
PendingClientIOsToMirror : 0
PendingRecoveryIOs : 0
RemoteReads : 0
RemoteWrites : 0
BytesRecovered : 0
BytesToRecover : 0
TotalReadTime : 0
TotalWriteTime : 0
MaxReadTime : 0
MaxWriteTime : 0
PercentReplaced : 0
CacheBackendTotalWrites : 0
CacheBackendTotalReads : 0
CacheBackendTotalWriteTime : 0
CacheBackendTotalReadTime : 0
CacheBackendMaxReadTime : 0
CacheBackendMaxWriteTime : 0
CacheBackendMaxIOTime : 0
CollectionTime : 12/18/2015 3:53:33 PM
NullCounterMap : 0
     

To Table of Contents

NAME

Get-DcsPhysicalDisk

SYNOPSIS

Returns tdata for physical disks and disks served to clients (hosts).

SYNTAX

Get-DcsPhysicalDisk   [ -Server <Object> ]   [ -Type <String[]> ]   [ -Available]   [ -Disk <Object> ]   [ -Pool <Object> ]   [ -Shared]   [ -PoolMember <Object> ]   [ -SharedDisk <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Get-DcsPhysicalDisk   [ -Server <Object> ]   [ -Type <String[]> ]   [ -Available]   [ -Disk <Object> ]   [ -Pool <Object> ]   [ -Shared]   [ -PoolMember <Object> ]   [ -SharedDisk <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Get-DcsPhysicalDisk   [ -Server <Object> ]   [ -Type <String[]> ]   [ -Available]   [ -Disk <Object> ]   [ -Pool <Object> ]   [ -NonShared]   [ -PoolMember <Object> ]   [ -SharedDisk <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns the data for physical disks and disks served to clients (hosts). Filtering parameters may be specified to narrow the scope of the data returned. If no parameters are specified, data for all physical disks for all servers and all disks served to hosts in the server group will be returned. Notes: As for physical disks that are used as pass-through disks, the entire volume is considered used and the free space will be 0. The free space value for a physical disk is only valid for physical disks that are not members of a pool. To get accurate and up-to-date values for this case, use the cmdlet Get-DcsPoolMember and pipe the object to Get-DcsPerformanceCounter.

PARAMETERS

-Server<Object>
Computer name or ID of a server. The computer name must be unique or the name must be fully qualified. If specified, only data for that server will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Type<String[]>
Type of physical disk. More than one type can be specified and only data for the specified types will be returned. Parameter values are "Mirrored", "PassThrough", "PoolDisk", "Basic", "Dynamic", "Uninitialized", and "Unknown". If not specified, data for all types will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Available<SwitchParameter>
Specify the Available parameter to only return data for physical disks that are available for use, such as disks that are not in disk pools and that are not used as pass-through disks.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Disk<Object>
PhysicalDiskData object, name, or ID that identifies a physical disk. To resolve by name, the name must be unique to the server group or the server must be specified. If the physical disk is specified, only data for that physical disk will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Pool<Object>
Name, or ID that identifies the disk pool. To resolve by name, the name must be unique to the server group or the server must be specified. If the pool is specified, only data for that pool will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Shared<SwitchParameter>
Specify this parameter to only return data for shared physical disks.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PoolMember<Object>
ID or caption that identifies a member of a disk pool. If the pool member is specified, only data for that pool member will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-SharedDisk<Object>
Name or Shared Physical Disk ID that identifies a shared physical disk. To resolve by name, the name must be unique to the server group or the server must be specified. If the shared physical disk is specified, only data for that shared physical disk will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-NonShared<SwitchParameter>
Specify this parameter to only return data for physical disks that are not shared by other servers.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

PhysicalDiskData : Object identifying and describing the disk.

OUTPUTS

PhysicalDiskData : Object identifying and describing the disk.

NOTES

Also see Add-DcsPoolMember, Get-DcsPoolMember, Get-DcsPoolDiskRelation, Unlock-DcsPhysicalDisk, Get-DcsSharedPhysicalDisk.

EXAMPLES

-------------- Example 1 Returns all uninitialized unitialized physical disk for a specified server --------------

Get-DcsPhysicalDisk -Server "SSVVM01" -Type "Uninitialized"

Returns data for all physical disks of type "Uninitialized" for the server "SSVVM01".

PoolMemberId :
HostId : 9A622809-4DE6-4B9F-9965-EF29852A1D9E
SharedPhysicalDiskId :
PresenceStatus : Present
Alias :
Size : 50 GB
SectorSize : 512 B
FreeSpace : 50.00 GB
InquiryData : DataCoreVirtual Disk DCS 125e932365eb408fa81b0d1fcd997c60
ScsiPath : Port 7, Bus 0, Target 0, LUN 3
DiskIndex : 4
SystemName : \\?\PhysicalDrive4
BusType : iScsi
Type : Uninitialized
DiskStatus : Online
Partitioned : False
InUse : False
IsBootDisk : False
Protected : True
IsSolidState : False
UniqueIdentifier : naa.60030d90e3c7bc02ebf5556fb27fd6c3
IsDataCoreDisk : True
SequenceNumber : 36441806
Id : {7261a103-2126-42c5-b414-dfa9ac93a9d4}
Caption : DataCoreVirtual Disk
ExtendedCaption : DataCoreVirtual Disk on SSVVM01
Internal : False
     
PoolMemberId :
HostId : 9A622809-4DE6-4B9F-9965-EF29852A1D9E
SharedPhysicalDiskId :
PresenceStatus : Present
Alias :
Size : 50 GB
SectorSize : 512 B
FreeSpace : 50.00 GB
InquiryData : DataCoreVirtual Disk DCS da8eaa010c154e42881282bbe483e915
ScsiPath : Port 7, Bus 0, Target 0, LUN 2
DiskIndex : 3
SystemName : \\?\PhysicalDrive3
BusType : iScsi
Type : Uninitialized
DiskStatus : Online
Partitioned : False
InUse : False
IsBootDisk : False
Protected : True
IsSolidState : False
UniqueIdentifier : naa.60030d9046c7bc02265710f7d15ed3bb
IsDataCoreDisk : True
SequenceNumber : 36441796
Id : {676d4f59-2b4d-4079-a496-5b8e30c34724}
Caption : DataCoreVirtual Disk
ExtendedCaption : DataCoreVirtual Disk on SSVVM01
Internal : False
     

-------------- Example 2 Returns data for a specified shared physical disk. --------------

Get-DcsPhysicalDisk -SharedDisk "SSV1-WDC50-D1"

The cmdlet is invoked using the SharedDisk parameter and a value of "SSV1-WDC50-D1", which is the unique name of a shared physical disk. Two objects are returned, one for each server sharing the disk.

PoolMemberId :
HostId : 8CE05A9F-D367-4BDE-BCE6-67909F6F7F6A
SharedPhysicalDiskId : naa.60030d9056566f6c3231000000000000
PresenceStatus : Present
Alias : SSV1-WDC50-D1
Size : 50.00 GB
SectorSize : 512 B
FreeSpace : 49.87 GB
InquiryData : DataCore SANmelody DCS VVol21
ScsiPath : Port 4, Bus 0, Target 4, LUN 6
DiskIndex : 9
SystemName : \\?\PhysicalDrive9
BusType : iScsi
Type : Basic
DiskStatus : Offline
Partitioned : False
InUse : False
IsBootDisk : False
Protected : False
UniqueIdentifier : naa.60030d9056566f6c3231000000000000
SequenceNumber : 32757
Id : {20b71485-f554-4538-977d-512a15b6d0b0}
Caption : SSV1-WDC50-D1
ExtendedCaption : SSV1-WDC50-D1 on SSV2
Internal : False
     
PoolMemberId : 2919eb02-f705-42ec-9ed5-4e2f7a2b7af9
HostId : 8BD7BD0F-F5F9-40DB-B8B0-6ABB74D43F81
SharedPhysicalDiskId : naa.60030d9056566f6c3231000000000000
PresenceStatus : Present
Alias : SSV1-WDC50-D1
Size : 50.00 GB
SectorSize : 512 B
FreeSpace : 49.87 GB
InquiryData : DataCore SANmelody DCS VVol21
ScsiPath : Port 4, Bus 0, Target 4, LUN 0
DiskIndex : 1
SystemName : \\?\PhysicalDrive1
BusType : iScsi
Type : Pool
DiskStatus : Online
Partitioned : True
InUse : True
IsBootDisk : False
Protected : False
UniqueIdentifier : naa.60030d9056566f6c3231000000000000
SequenceNumber : 32752
Id : {eaf8d9c0-302b-4c4a-9d37-23b0b407f668}
Caption : SSV1-WDC50-D1
ExtendedCaption : SSV1-WDC50-D1 on SSV1
Internal : False
     

To Table of Contents

NAME

Get-DcsPhysicalDiskPath

SYNOPSIS

Returns the mirror and back-end path data for physical disks.

SYNTAX

Get-DcsPhysicalDiskPath   [ -Server <String> ]   [ -Disk <String> ]   [ -Port <String> ]   [ -DiskPath <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns the mirror and back-end path data for physical disks. Filtering parameters may be specified to narrow the scope of the data returned. If no parameters are specified, path data for all physical disks belonging to all servers in the default connection will be returned.

PARAMETERS

-Server<String>
Computer name or ID of a server. The computer name must be unique or the name must be fully qualified. If a server is specified, only data for that server will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Disk<String>
Name or ID of the physical disk. To resolve by name, the name must be unique to the server group or the server must be specified. If the disk is specified, only data for that disk will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Port<String>
Name or ID of a port. To uniquely identify a port by name, the server must be specified. If a port is specified, only data for that port will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-DiskPath<Object>
DiskPathData object or ID that identifies a physical disk path. If specified, only data for that disk path will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

DiskPathData : Object that identifies and describes the disk path.

OUTPUTS

DiskPathData : Object that identifies and describes the disk path.

NOTES

Also see Set-DcsPhysicalDiskPathPreference, Get-DcsPhysicalDisk.

EXAMPLES

-------------- Example 1 Returns physical disk data for a server specified by name --------------

Get-DcsPhysicalDiskPath -Server SSV1

Returns all physical disk path data for the server named "SSV1".

DiskId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:naa.60030d9056566f6c335f535356315f35
InitiatorPortId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:MSFT-05-1991
TargetPortId : iqn.2000-08.com.datacore:vm-host-ex-1
Lun : 0
Active : True
Preferred : False
Id : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:naa.60030d9056566f6c335f535356315f35-[I:MSFT-05-1991 T:iqn.2000-08.com.datacore:vm-host-ex-1 L:0]
Caption : LUN 0 on Microsoft iSCSI Initiator on SSV1 from iqn.2000-08.com.datacore:vm-host-ex-1
ExtendedCaption : LUN 0 on Microsoft iSCSI Initiator on SSV1 from iqn.2000-08.com.datacore:vm-host-ex-1
Internal : False
     
DiskId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:naa.60030d9056566f6c345f535356315f35
InitiatorPortId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:MSFT-05-1991
TargetPortId : iqn.2000-08.com.datacore:vm-host-ex-1
Lun : 1
Active : True
Preferred : False
Id : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:naa.60030d9056566f6c345f535356315f35-[I:MSFT-05-1991 T:iqn.2000-08.com.datacore:vm-host-ex-1 L:1]
Caption : LUN 1 on Microsoft iSCSI Initiator on SSV1 from iqn.2000-08.com.datacore:vm-host-ex-1
ExtendedCaption : LUN 1 on Microsoft iSCSI Initiator on SSV1 from iqn.2000-08.com.datacore:vm-host-ex-1
Internal : False
     
DiskId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:naa.60030d9056566f6c355f535356315f31
InitiatorPortId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:MSFT-05-1991
TargetPortId : iqn.2000-08.com.datacore:vm-host-ex-1
Lun : 2
Active : True
Preferred : False
Id : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:naa.60030d9056566f6c355f535356315f31-[I:MSFT-05-1991 T:iqn.2000-08.com.datacore:vm-host-ex-1 L:2]
Caption : LUN 2 on Microsoft iSCSI Initiator on SSV1 from iqn.2000-08.com.datacore:vm-host-ex-1
ExtendedCaption : LUN 2 on Microsoft iSCSI Initiator on SSV1 from iqn.2000-08.com.datacore:vm-host-ex-1
Internal : False
     
DiskId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:naa.60030d9056566f6c365f535356315f31
InitiatorPortId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:MSFT-05-1991
TargetPortId : iqn.2000-08.com.datacore:vm-host-ex-1
Lun : 3
Active : True
Preferred : False
Id : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:naa.60030d9056566f6c365f535356315f31-[I:MSFT-05-1991 T:iqn.2000-08.com.datacore:vm-host-ex-1 L:3]
Caption : LUN 3 on Microsoft iSCSI Initiator on SSV1 from iqn.2000-08.com.datacore:vm-host-ex-1
ExtendedCaption : LUN 3 on Microsoft iSCSI Initiator on SSV1 from iqn.2000-08.com.datacore:vm-host-ex-1
Internal : False
     
DiskId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:naa.60030d9056566f6c34325f535356315f
InitiatorPortId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:MSFT-05-1991
TargetPortId : iqn.2000-08.com.datacore:vm-host-ex-1
Lun : 4
Active : True
Preferred : False
Id : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:naa.60030d9056566f6c34325f535356315f-[I:MSFT-05-1991 T:iqn.2000-08.com.datacore:vm-host-ex-1 L:4]
Caption : LUN 4 on Microsoft iSCSI Initiator on SSV1 from iqn.2000-08.com.datacore:vm-host-ex-1
ExtendedCaption : LUN 4 on Microsoft iSCSI Initiator on SSV1 from iqn.2000-08.com.datacore:vm-host-ex-1
Internal : False
     
DiskId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:naa.60030d9056566f6c34335f535356315f
InitiatorPortId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:MSFT-05-1991
TargetPortId : iqn.2000-08.com.datacore:vm-host-ex-1
Lun : 5
Active : True
Preferred : False
Id : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:naa.60030d9056566f6c34335f535356315f-[I:MSFT-05-1991 T:iqn.2000-08.com.datacore:vm-host-ex-1 L:5]
Caption : LUN 5 on Microsoft iSCSI Initiator on SSV1 from iqn.2000-08.com.datacore:vm-host-ex-1
ExtendedCaption : LUN 5 on Microsoft iSCSI Initiator on SSV1 from iqn.2000-08.com.datacore:vm-host-ex-1
Internal : False
     
DiskId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:naa.60030d9056566f6c34345f535356315f
InitiatorPortId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:MSFT-05-1991
TargetPortId : iqn.2000-08.com.datacore:vm-host-ex-1
Lun : 6
Active : True
Preferred : False
Id : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:naa.60030d9056566f6c34345f535356315f-[I:MSFT-05-1991 T:iqn.2000-08.com.datacore:vm-host-ex-1 L:6]
Caption : LUN 6 on Microsoft iSCSI Initiator on SSV1 from iqn.2000-08.com.datacore:vm-host-ex-1
ExtendedCaption : LUN 6 on Microsoft iSCSI Initiator on SSV1 from iqn.2000-08.com.datacore:vm-host-ex-1
Internal : False
     
DiskId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:naa.60030d9056566f6c34385f35305f5353
InitiatorPortId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:MSFT-05-1991
TargetPortId : iqn.2000-08.com.datacore:vm-host-ex-1
Lun : 7
Active : True
Preferred : False
Id : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:naa.60030d9056566f6c34385f35305f5353-[I:MSFT-05-1991 T:iqn.2000-08.com.datacore:vm-host-ex-1 L:7]
Caption : LUN 7 on Microsoft iSCSI Initiator on SSV1 from iqn.2000-08.com.datacore:vm-host-ex-1
ExtendedCaption : LUN 7 on Microsoft iSCSI Initiator on SSV1 from iqn.2000-08.com.datacore:vm-host-ex-1
Internal : False
     
DiskId : V.{315f03ec-bdf5-11e0-9dc3-00155d11e923}-0000002A_N.22430030D9D4116D
InitiatorPortId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:MSFT-05-1991
TargetPortId : C553D471-3527-47EC-9326-D53E04204F2B:MAC:00-15-5D-11-E9-10
Lun : 0
Active : True
Preferred : False
Id : V.{315f03ec-bdf5-11e0-9dc3-00155d11e923}-0000002A_N.22430030D9D4116D-[I:MSFT-05-1991 T:iqn.2000-08.com.datacore:ssv2-1 L:0]
Caption : LUN 0 on Microsoft iSCSI Initiator on SSV1 from Server iSCSI Port 1 on SSV2
ExtendedCaption : LUN 0 on Microsoft iSCSI Initiator on SSV1 from Server iSCSI Port 1 on SSV2
Internal : False
     

-------------- Example 2 Returns physical disk path data for a physical disk specified by name --------------

Get-DcsPhysicalDiskPath -Server SSV1 -Disk "Disk 1"

Returns physical disk path data for the physical disk named "Disk 1" on the server named "SSV1".

DiskId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:naa.60030d9056566f6c335f535356315f35
InitiatorPortId : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:MSFT-05-1991
TargetPortId : iqn.2000-08.com.datacore:vm-host-ex-1
Lun : 0
Active : True
Preferred : False
Id : 84972D6B-7E71-4616-BDA1-57ECEAF3FFC4:naa.60030d9056566f6c335f535356315f35-[I:MSFT-05-1991 T:iqn.2000-08.com.datacore:vm-host-ex-1 L:0]
Caption : LUN 0 on Microsoft iSCSI Initiator on SSV1 from iqn.2000-08.com.datacore:vm-host-ex-1
ExtendedCaption : LUN 0 on Microsoft iSCSI Initiator on SSV1 from iqn.2000-08.com.datacore:vm-host-ex-1
Internal : False
     

To Table of Contents

NAME

Get-DcsPool

SYNOPSIS

Returns the data for disk pools.

SYNTAX

Get-DcsPool   [ -Server <Object> ]   [ -Pool <Object> ]   [ -SharedPool <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Get-DcsPool   [ -Server <Object> ]   [ -Pool <Object> ]   [ -SharedPool <Object> ]   [ -Shared]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Get-DcsPool   [ -Server <Object> ]   [ -Pool <Object> ]   [ -NonShared]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns the data for disk pools. Filtering parameters may be specified to narrow the scope of the data returned. If no parameters are specified, data for all disk pools belonging to all servers in the default server group connection will be returned.

PARAMETERS

-Server<Object>
ServerHostData object, computer name or ID of the server. The computer name must be unique or the name must be fully qualified. If a server is specified, only data for that server will be returned. The ServerHostData object can be obtained from Get-DcsServer.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Pool<Object>
DiskPoolData object, name, or ID that identifies a disk pool. To resolve by name, the name must be unique to the server group or the server must be specified. If the pool is specified, only data for that pool will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-SharedPool<Object>
SharedDiskPoolData object, name, or ID that identifies a shared disk pool. To resolve by name, the name must be unique to the server group or the server must be specified. If a shared pool is specified, only data for that shared pool will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Shared<SwitchParameter>
Specify this parameter for data on shared pools only.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-NonShared<SwitchParameter>
Specify this parameter for data on non-shared pools only.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

DiskPoolData : Object that identifies and describes the pool.

OUTPUTS

DiskPoolData : Object that identifies and describes the pool.

NOTES

Also see Set-DcsPoolProperties, Get-DcsChunkAllocation, Get-DcsChunkAllocationMap, Get-DcsChunkReclamationMap, Add-DcsPool, Get-DcsSharedPool.

EXAMPLES

-------------- Example 1 Returns data for a pool specified by name --------------

Get-DcsPool -Pool "Disk pool 1"

The cmdlet is invoked with the parameter Pool. The pool name is "Disk pool 1" which is unique to the server group so the parameter Server is not necessary.
Returns data for "Disk pool 1" on the server "SSV1".
PoolMode : ReadWrite
ServerId : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3
SharedPoolId :
Alias : Disk pool 1
Description :
PresenceStatus : Present
PoolStatus : Running
Type : Dynamic
ChunkSize : 128.00 MB
SectorSize : 512 B
MaxTierNumber : 3
TierReservedPct : 0
AutoTieringEnabled : True
IsAuthorized : True
InSharedMode : False
SMPAApproved : False
SequenceNumber : 6942
Id : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3:{ea7c7a80-bdf3-11e0-8304-00155d11e921}
Caption : Disk pool 1
ExtendedCaption : Disk pool 1 on SSV1
Internal : False
     

-------------- Example 2 Returns data for all pools on a server specified by name --------------

Get-DcsPool -Server SSV1

Returns data for all pools on server "SSV1". There are two pools.

PoolMode : ReadWrite
ServerId : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3
SharedPoolId :
Alias : Disk pool 1
Description :
PresenceStatus : Present
PoolStatus : Running
Type : Dynamic
ChunkSize : 128.00 MB
SharedPoolId :
MaxTierNumber : 3
AutoTieringEnabled : True
IsAuthorized : True
InSharedMode : False
SMPAApproved : False
SequenceNumber : 6942
Id : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3:{ea7c7a80-bdf3-11e0-8304-00155d11e921}
Caption : Disk pool 1
ExtendedCaption : Disk pool 1 on SSV1
Internal : False
     
PoolMode : ReadWrite
ServerId : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3
SharedPoolId :
Alias : Disk pool 2
Description :
PresenceStatus : Present
PoolStatus : Running
Type : Dynamic
ChunkSize : 128.00 MB
SectorSize : 512 B
MaxTierNumber : 3
AutoTieringEnabled : True
IsAuthorized : True
InSharedMode : False
SMPAApproved : False
SequenceNumber : 6942
Id : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3:{8d8cb33b-c37e-11e0-90c4-00155d11e921}
Caption : Disk pool 2
ExtendedCaption : Disk pool 2 on SSV1
Internal : False
     

-------------- Example 3 Returns data for a shared pool --------------

Get-DcsPool -SharedPool shared-pool-1

The cmdlet is invoked with the parameter SharedPool. The name of the shared pool is "shared-pool-1". An object is returned for each server that shares the pool.

PoolMode : ReadWrite
ServerId : F0AE5233-62EC-4006-A0C7-0BD308F84D28
SharedPoolId : {c5d2cc01-0b41-11e3-9829-002590570c2f}
Alias : shared-pool-1
Description :
PresenceStatus : Present
PoolStatus : Running
Type : Dynamic
ChunkSize : 128.00 MB
MaxTierNumber : 3
AutoTieringEnabled : True
IsAuthorized : False
InSharedMode : False
SequenceNumber : 41285
Id : F0AE5233-62EC-4006-A0C7-0BD308F84D28:{c5d2cc01-0b41-11e3-9829-002590570c2f}
Caption : shared-pool-1
ExtendedCaption : shared-pool-1 on Heavy
Internal : False
     
PoolMode : ReadWrite
ServerId : 45C4A667-7A9B-4BF0-9E6D-EFEA0EF01A0E
SharedPoolId : {c5d2cc01-0b41-11e3-9829-002590570c2f}
Alias : shared-pool-1
Description :
PresenceStatus : Present
PoolStatus : Running
Type : Dynamic
ChunkSize : 128.00 MB
SectorSize : 512 B
MaxTierNumber : 3
AutoTieringEnabled : True
IsAuthorized : True
InSharedMode : True
SequenceNumber : 41284
Id : 45C4A667-7A9B-4BF0-9E6D-EFEA0EF01A0E:{c5d2cc01-0b41-11e3-9829-002590570c2f}
Caption : shared-pool-1
ExtendedCaption : shared-pool-1 on Metal
Internal : False
     

-------------- Example 4 Returns data for all shared pools in the server group --------------

Get-DcsPool -Shared

The cmdlet is invoked with the switch parameter Shared and objects are returned for all shared pools on all servers in the default server group. Data for all non-shared pools are excluded.

PoolMode : ReadWrite
ServerId : 842E17B3-B000-4553-B711-7BE46FA260FF
SharedPoolId : {b490ba62-8e9a-11e3-bbb8-00155d11e952}
Alias : SharedPool1
Description :
PresenceStatus : Present
PoolStatus : Running
Type : Dynamic
ChunkSize : 128.00 MB
SectorSize : 512 B
MaxTierNumber : 3
AutoTieringEnabled : True
IsAuthorized : True
InSharedMode : True
SequenceNumber : 7181
Id : 842E17B3-B000-4553-B711-7BE46FA260FF:{b490ba62-8e9a-11e3-bbb8-00155d11e952}
Caption : SharedPool1
ExtendedCaption : SharedPool1 on SSV1
Internal : False
     
PoolMode : ReadWrite
ServerId : FF212987-2B4F-40DD-A490-A0CA13E58FDF
SharedPoolId : {b490ba62-8e9a-11e3-bbb8-00155d11e952}
Alias : SharedPool1
Description :
PresenceStatus : Present
PoolStatus : Running
Type : Dynamic
ChunkSize : 128.00 MB
SectorSize : 512 B
MaxTierNumber : 3
AutoTieringEnabled : True
IsAuthorized : True
InSharedMode : True
SequenceNumber : 7189
Id : FF212987-2B4F-40DD-A490-A0CA13E58FDF:{b490ba62-8e9a-11e3-bbb8-00155d11e952}
Caption : SharedPool1
ExtendedCaption : SharedPool1 on SSV2
Internal : False
     
PoolMode : ReadWrite
ServerId : 842E17B3-B000-4553-B711-7BE46FA260FF
SharedPoolId : {b490ba64-8e9a-11e3-bbb8-00155d11e952}
Alias : SharedPool2
Description :
PresenceStatus : Present
PoolStatus : Running
Type : Dynamic
ChunkSize : 128.00 MB
SectorSize : 512 B
MaxTierNumber : 3
AutoTieringEnabled : True
IsAuthorized : True
InSharedMode : True
SequenceNumber : 7218
Id : 842E17B3-B000-4553-B711-7BE46FA260FF:{b490ba64-8e9a-11e3-bbb8-00155d11e952}
Caption : SharedPool2
ExtendedCaption : SharedPool2 on SSV1
Internal : False
     
PoolMode : ReadWrite
ServerId : FF212987-2B4F-40DD-A490-A0CA13E58FDF
SharedPoolId : {b490ba64-8e9a-11e3-bbb8-00155d11e952}
Alias : SharedPool2
Description :
PresenceStatus : Present
PoolStatus : Running
Type : Dynamic
ChunkSize : 128.00 MB
SectorSize : 512 B
MaxTierNumber : 3
AutoTieringEnabled : True
IsAuthorized : False
InSharedMode : False
SequenceNumber : 7226
Id : FF212987-2B4F-40DD-A490-A0CA13E58FDF:{b490ba64-8e9a-11e3-bbb8-00155d11e952}
Caption : SharedPool2
ExtendedCaption : SharedPool2 on SSV2
Internal : False
     

To Table of Contents

NAME

Get-DcsPoolMember

SYNOPSIS

Returns data for physical disks in a disk pool.

SYNTAX

Get-DcsPoolMember   [ -Server <String> ]   [ -Pool <String> ]   [ -Disk <String> ]   [ -PoolMember <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns data for physical disks in a disk pool. If a physical disk is mirrored in the pool, one object will be returned that describes both disks in the mirror. Filtering parameters may be specified to narrow the scope of the data returned. If no parameters are specified, data for all physical disks in pools belonging to all servers in the default connection will be returned.

PARAMETERS

-Server<String>
Computer name or ID of the server. The computer name must be unique or the name must be fully qualified. If a server is specified, only data for that server will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Pool<String>
Name or ID that identifies a disk pool. To resolve by name, the name must be unique to the server group or the server must be specified. If a pool is specified, only data for that pool will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Disk<String>
Name or ID that identifies a physical disk. To resolve by name, the name must be unique to the server group or the server must be specified. If the physical disk is specified, only data for that physical disk will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PoolMember<Object>
PoolMemberData object, ID or caption that identifies the pool member of a disk pool. If the pool member is specified, only data for that pool member will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

PoolMemberData : Object the identifies and describes the pool member.

OUTPUTS

PoolMemberData : Object the identifies and describes the pool member.

NOTES

Also see Add-DcsPoolMember, Get-DcsPool, Get-DcsPhysicalDisk.

EXAMPLES

-------------- Example 1 Returns data for a pool specified by name --------------

Get-DcsPoolMember -Pool "Disk pool 1"

Returns data for all pool members in the pool named "Disk pool 1". In this case, there is one pool disk and one pool mirror in the pool.

DiskPoolId : 8BD7BD0F-F5F9-40DB-B8B0-6ABB74D43F81:{2b28c5b6-a04d-11e1-96c0-00155d11e929}
DiskInRecoveryId : {0b89a4a7-242e-4f8b-926f-ecc9397d5cdf}
DiskTier : 2
MemberState : InRecovery
Size : 100.00 GB
SectorSize : 512 B
IsMirrored : True
SequenceNumber : 7752
Id : ed78b36a-613a-4c28-b4d8-f00d0fc5fbec
Caption : SSV1-WDC100-D1|SSV1-WDC100-D2
ExtendedCaption : Pool mirror SSV1-WDC100-D1|SSV1-WDC100-D2 on SSV1
Internal : False
     
DiskPoolId : 8BD7BD0F-F5F9-40DB-B8B0-6ABB74D43F81:{2b28c5b6-a04d-11e1-96c0-00155d11e929}
DiskInRecoveryId :
DiskTier : 2
MemberState : Healthy
Size : 50.00 GB
SectorSize : 512 B
IsMirrored : False
SequenceNumber : 7640
Id : 9661d57d-30a5-4994-925e-ba92e0f067ad
Caption : SSV1-WDC50-D1
ExtendedCaption : Pool disk SSV1-WDC50-D1 on SSV1
Internal : False
     

-------------- Example 2 Returns data for a pool member specified by caption --------------

Get-DcsPoolMember -Disk "SSV1-WDC50-D1"

Returns data for the pool member named "SSV1-WDC50-D1". In this case, the name is unique in the server group and can be resolved without additional parameters.

DiskPoolId : 8BD7BD0F-F5F9-40DB-B8B0-6ABB74D43F81:{2b28c5b6-a04d-11e1-96c0-00155d11e929}
DiskInRecoveryId :
DiskTier : 2
MemberState : Healthy
Size : 50.00 GB
SectorSize : 512 B
IsMirrored : False
SequenceNumber : 7640
Id : 9661d57d-30a5-4994-925e-ba92e0f067ad
Caption : SSV1-WDC50-D1
ExtendedCaption : Pool disk SSV1-WDC50-D1 on SSV1
Internal : False
     

-------------- Example 3 Retrieves performance metrics for physical disks in a specified pool. --------------

Get-DcsPoolMember -Pool "Disk pool 1" | Get-DcsPerformanceCounter

The cmdlet Get-DcsPoolMember is invoked to obtain the PoolMemberData object for the pool "Disk pool 1" and the results are piped to the cmdlet Get-DcsPerformanceCounter to retrieve the counters for the physical disk in the pool. In this case, there is one physical disk in the pool so one object is returned.

BytesAllocated : 268435456
BytesAvailable : 20803747840
BytesInReclamation : 0
BytesRecovered : 0
BytesRemainingToRecover : 0
BytesTotalToRecover : 0
BytesMigrated : 0
CollectionTime : 9/8/2015 8:18:16 PM
NullCounterMap : 0
     

To Table of Contents

NAME

Get-DcsPort

SYNOPSIS

Returns the port data for SCSI ports.

SYNTAX

Get-DcsPort   [ -Type <String[]> ]   [ -Machine <Object> ]   [ -MachineType <String> ]   [ -Port <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Get-DcsPort   [ -Type <String[]> ]   [ -Unassigned]   [ -Port <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns the port data for SCSI ports. Filtering parameters may be specified to narrow the scope of the data returned. If no parameters are specified, data for all SCSI ports for all servers and all associated clients in the server group of the default connection will be returned.

PARAMETERS

-Type<String[]>
Type of SCSI port. Parameter values are "iSCSI", "FibreChannel", and "Loopback". If one or more types are specified, only data for those port types will be returned. If not specified, data for all types will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Machine<Object>
Computer name or ID that identifies a server or client (host) machine. The computer name for a server must be unique or the names must be fully qualified. If a machine is specified, only data involving that machine will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-MachineType<String>
This parameter is used to limit the return of data by the type of machine. Possible values include "Servers", "Clients" (host), or "All".

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Port<Object>
ScsiPortData object, name, or ID that identifies a port. To uniquely identify a port by name, the server must be specified. If a port is specified, only data for that port will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Unassigned<SwitchParameter>
Use this parameter to only return ports that are not assigned to a client (host). If this parameter not specified, all assigned and unassigned ports will be returned. If specifying this parameter, omit the MachineType parameter when invoking this cmdlet.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

ScsiPortData : Object that identifies and describes the port.

OUTPUTS

ScsiPortData : Object that identifies and describes the port.

NOTES

Also see Get-DcsPortConnection, Get-DcsiSCSISession. To set port properties, see Set-DcsServerPortProperties or Set-DcsPortProperties.

EXAMPLES

-------------- Example 1 Returns data for a port specified by name --------------

Get-DcsPort -Port "Microsoft iSCSI Initiator"

Returns data for all ports named "Microsoft iSCSI Initiator" in the server group.

InitiatorPortals : {fe80::2de4:e3b4:87d0:b299, fe80::d86e:28b1:6c8e:ee36, fe80::ac9f:4abc:8e7:447a, fe80::f13e:c21d:f0b8:c2e...}
iSnsServer : {}
TargetPortals : {DataCore.Executive.iScsiTargetPortalData}
PresenceStatus : Present
PhysicalName : MSFT-05-1991
ServerPortProperties : DataCore.Executive.ServerPortPropertiesData
RoleCapability : Backend, Mirror
PortName : iqn.1991-05.com.microsoft.ssv1.datacoresoftware.com
Alias : Microsoft iSCSI Initiator
Description :
PortType : iSCSI
PortMode : Initiator
HostId : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3
Connected : True
Id : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3:MSFT-05-1991
Caption : Microsoft iSCSI Initiator
ExtendedCaption : Microsoft iSCSI Initiator on SSV1
Internal : False
     
InitiatorPortals : {fe80::4845:95ea:39c3:6fa6, fe80::706f:1642:d9f4:d1b7, fe80::6181:9311:6644:c8d2, fe80::2920:ddc6:93a7:45df...}
iSnsServer : {}
TargetPortals : {DataCore.Executive.iScsiTargetPortalData, DataCore.Executive.iScsiTargetPortalData, DataCore.Executive.iScsiTargetPortalData, DataCore.Executive.iScsi TargetPortalData...}
PresenceStatus : Present
PhysicalName : MSFT-05-1991
ServerPortProperties : DataCore.Executive.ServerPortPropertiesData
RoleCapability : Backend, Mirror
PortName : iqn.1991-05.com.microsoft:ssv2.datacoresoftware.com
Alias : Microsoft iSCSI Initiator
Description :
PortType : iSCSI
PortMode : Initiator
HostId : 781D998D-3920-46BB-9F26-88BC591772B6
Connected : True
Id : 781D998D-3920-46BB-9F26-88BC591772B6:MSFT-05-1991
Caption : Microsoft iSCSI Initiator
ExtendedCaption : Microsoft iSCSI Initiator on SSV2
Internal : False
     

-------------- Example 2 Returns server port properties for a specific port --------------

(Get-DcsPort -Machine "SSVVM04" -Port "Server iSCSI Port 1").ServerPortProperties

Returns server port properties for the port named Server iSCSI Port 1 on the server named SSVVM04.

Active : True
Alias :
Authentication : CHAP
AutoLoginMode : Default
DisablePortWhileStopped : True
Discovery : DataCore.Executive.iSCSI.DiscoveryConfig
InstanceName : MAC:00-15-5D-13-89-10
ISID : 140737488355328
MaxActiveICommands : 0
MaxActiveTCommands : 256
NodeName : iqn.2000-08.com.datacore:ssvvm04-1
IScsiPortalsConfig : {DataCore.Executive.iSCSI.iScsiPortalConfigInfo}
RecoveryLevel : Default
ScsiMode : Target
SessionParams : DataCore.Executive.iSCSI.SessionParams
TPGT : 1
Role : Frontend, Mirror
PortGroup : Zone 1
     

-------------- Example 3 Returns data for all unassigned ports of a specified type --------------

Get-DcsPort -Type iSCSI -Unassigned

Returns data for all iSCSI ports that are currently unassigned. There are four ports.

HostId :
PortName : iqn.1991-05.com.microsoft:host1.datacoresoftware.com
Alias :
Description :
PortType : iSCSI
PortMode : Initiator
Connected : True
Id : iqn.1991-05.com.microsoft:host1.datacoresoftware.com
Caption : iqn.1991-05.com.microsoft:host1.datacoresoftware.com
ExtendedCaption : iqn.1991-05.com.microsoft:host1.datacoresoftware.com
Internal : False
     
HostId :
PortName : iqn.1991-05.com.microsoft:host4.datacoresoftware.com
Alias :
Description :
PortType : iSCSI
PortMode : Initiator
Connected : True
Id : iqn.1991-05.com.microsoft:host4.datacoresoftware.com
Caption : iqn.1991-05.com.microsoft:host4.datacoresoftware.com
ExtendedCaption : iqn.1991-05.com.microsoft:host4.datacoresoftware.com
Internal : False
     
HostId :
PortName : iqn.2000-08.com.datacore:vm-host-ex-1
Alias :
Description :
PortType : iSCSI
PortMode : Target
Connected : True
Id : iqn.2000-08.com.datacore:vm-host-ex-1
Caption : iqn.2000-08.com.datacore:vm-host-ex-1
ExtendedCaption : iqn.2000-08.com.datacore:vm-host-ex-1
Internal : False
     
HostId :
PortName : iqn.1991-05.com.microsoft:host2.datacoresoftware.com
Alias :
Description :
PortType : iSCSI
PortMode : Initiator
Connected : True
Id : iqn.1991-05.com.microsoft:host2.datacoresoftware.com
Caption : iqn.1991-05.com.microsoft:host2.datacoresoftware.com
ExtendedCaption : iqn.1991-05.com.microsoft:host2.datacoresoftware.com
Internal : False
     

To Table of Contents

NAME

Get-DcsPortConnection

SYNOPSIS

Returns port connection data.

SYNTAX

Get-DcsPortConnection   [ -PortConnection <Object> ]   [ -Port <String> ]   [ -Machine <String> ]   [ -ConnectionType <String> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Get-DcsPortConnection   [ -PortConnection <Object> ]   [ -PortA <String> ]   [ -MachineA <String> ]   [ -PortB <String> ]   [ -MachineB <String> ]   [ -ConnectionType <String> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns port connection data. Filtering parameters may be specified to narrow the scope of the data returned. If no parameters are specified, data for all port connections for all servers in the default connection will be returned.

PARAMETERS

-PortConnection<Object>
PortConnectionData object or ID that identifies a port connection. If a port connection is specified, only data for that port connection will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Port<String>
Name or ID of a port. To uniquely identify a port by name, the machine must be specified. If a port is specified, only data for that port will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Machine<String>
Computer name or ID for a server, or the name or ID for a client machine. Computer names for servers must be unique or the names must be fully qualified. If a machine is specified, only port connection data for that machine will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-ConnectionType<String>
This parameter is used to limit the return of data by the port type. Possible values include "FibreChannel", "iSCSI", or "All". "All" will return connection data for all port types.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PortA<String>
Name or ID of a initiator port in a path. To uniquely identify a port by name, the parameter MachineA must be specified. This parameter can be used with PortB to identify two ports in a path. If PortA is specified, only data for that port will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-MachineA<String>
Computer name or ID for a server, or the name or ID for a client machine. Computer names for servers must be unique or the names must be fully qualified. If MachineA is specified, only data for that machine will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PortB<String>
Name or ID of a target port in a path. To uniquely identify a port by name, the parameter MachineB must be specified. This parameter can be used with PortA to identify two ports in a path. If PortB is specified, only data for that port will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-MachineB<String>
Computer name or ID for a server, or the name or ID for a client machine. Computer names for servers must be unique or the names must be fully qualified. If MachineB is specified, only data for that machine will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

PortConnectionData : Object that identifies and describes a port connection.

OUTPUTS

PortConnectionData : Object that identifies and describes a port connection.

NOTES

Also see Get-DcsPort.

EXAMPLES

-------------- Example 1 Returns connection data for a port specified by name --------------

Get-DcsPortConnection -Port "Microsoft iSCSI Initiator" -Machine SSV1

Returns data for connections involving the port named "Microsoft iSCSI Initiator" on the machine named "SSV1".

PortADescriptor : DataCore.Executive.iSCSI.SessionDescriptor
PortBDescriptor : DataCore.Executive.iSCSI.SessionDescriptor
Target :
Connected : True
PortAId : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3:MSFT-05-1991
PortBId : 781D998D-3920-46BB-9F26-88BC591772B6:MAC:00-15-5D-11-E9-22
Id : 15d8e3340cdb435d9b2d10b06036e03b
Caption : Microsoft iSCSI Initiator on SSV1 to Server iSCSI Port 3 on SSV2
ExtendedCaption : Microsoft iSCSI Initiator on SSV1 to Server iSCSI Port 3 on SSV2
Internal : False
     
PortADescriptor : DataCore.Executive.iSCSI.SessionDescriptor
PortBDescriptor : DataCore.Executive.iSCSI.SessionDescriptor
Target :
Connected : True
PortAId : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3:MSFT-05-1991
PortBId : 781D998D-3920-46BB-9F26-88BC591772B6:MAC:00-15-5D-11-E9-23
Id : b47cb891604047569f7036e75193bb01
Caption : Microsoft iSCSI Initiator on SSV1 to Server iSCSI Port 4 on SSV2
ExtendedCaption : Microsoft iSCSI Initiator on SSV1 to Server iSCSI Port 4 on SSV2
Internal : False
     
PortADescriptor : DataCore.Executive.iSCSI.SessionDescriptor
PortBDescriptor :
Target :
Connected : True
PortAId : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3:MSFT-05-1991
PortBId : iqn.2000-08.com.datacore:vm-host-ex-1
Id : 2953c2e974414ae5a02bbc09d0fe65f5
Caption : Microsoft iSCSI Initiator on SSV1 to iqn.2000-08.com.datacore:vm-host-ex-1
ExtendedCaption : Microsoft iSCSI Initiator on SSV1 to iqn.2000-08.com.datacore:vm-host-ex-1
Internal : False
     

-------------- Example 2 Returns data for two specified ports in a path --------------

Get-DcsPortConnection -PortA "Microsoft iSCSI Initiator" -MachineA SSV1 -PortB "Server iSCSI Port 1" -MachineB SSV2

Returns data for two ports that consist of the endpoints of a path. The endpoints of the path consist of PortA named "Microsoft iSCSI Initiator" on MachineA named "SSV1" to PortB named "Server iSCSI Port 1" on MachineB named "SSV2".

PortADescriptor : DataCore.Executive.iSCSI.SessionDescriptor
PortBDescriptor : DataCore.Executive.iSCSI.SessionDescriptor
Target :
Connected : True
PortAId : fc3a73e9-28f4-4e2f-a8e5-cdc50beb045b
PortBId : ef2bd94f-e093-4305-994d-435bde2ec455
Id : b1c80cb79b5f46569ceee6b5ade324b0
Caption : Microsoft iSCSI Initiator on SSV1 to Server iSCSI Port 1 on SSV2
ExtendedCaption : Microsoft iSCSI Initiator on SSV1 to Server iSCSI Port 1 on SSV2
Internal : False
     

To Table of Contents

NAME

Get-DcsPurgePrerequisites

SYNOPSIS

Returns prerequisite actions needed to be performed before purging a failed pool disk.

SYNTAX

Get-DcsPurgePrerequisites   -Disk <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns prerequisite actions needed to be performed before purging a failed pool disk. After completing prerequisite actions, see Purge-DcsPoolMember to begin the purge operation for the disk.

PARAMETERS

-Disk<Object>
PhysicalDiskData object, name, or ID that identifies a physical disk. To resolve by name, the name must be unique to the server group.

Required: true
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

PhysicalDiskData : Object identifying and describing a physical disk.

OUTPUTS

VirtualDiskChunkStatistics : Object containing virtual disk information on the physical disk, such as ID, allocated size on the disk and total allocated size, along with actions that need to be taken for each virtual disk.

NOTES

Also see Purge-DcsPoolMember, Get-DcsPhysicalDisk.

EXAMPLES

-------------- Example 1 Gets purge prerequisites for a disk specified by name --------------

Get-DcsPurgePrerequisites -Disk "Disk2"

The prerequisite actions needed to purge the disk named "Disk2" from the configuration are retrieved. The VirtualDiskChunkStatistics object is returned, which includes information for the virtual disks that will be affected by the purge operation: the virtual disk ID, size of the allocation on the failed disk, total allocation size of the virtual disk, and the actions required so that the purge operation can be performed. After all actions have been performed, the cmdlet Purge-DcsPoolMember can be run to perform the purge operation.

Id                                                      AllocatedSizeOnDisk                   AllocatedSizeTotal                              Actions
--                                                      -------------------                   ------------------                              -------
af4a7c67d3484b02858d0849451e5ee5                                 6979321856                          13287555072                                 None
97cdc9be7747421da532c1f9a0c9c43e                                 4563402752                           9529458688 ...eleteSnapshots, SplitFailedMirror
001e75810bf24809bf98e1a7a416afee                                 7113539584                          11542724608                     SplitReplication
344410225d844622afd82e1f9d9023f4                                  268435456                            268435456          SplitMirrorAndDeleteCdpDisk
88d953cd90654f93a57c543ef2b00e56                                 4563402752                          10468982784                                 None
                                

-------------- Example 2 Gets purge prerequisites for a failed pool disk by ID --------------

$FailedDisks = Get-DcsPhysicalDisk -Type PoolDisk | Get-DcsMonitor | Where-Object -Filterscript {$_.State -eq "Critical"}

$FailedDisks.MonitoredObjectId | Get-DcsPurgePrerequisites

The cmdlet Get-DcsPhysicalDisk is invoked to get the PhysicalDiskData objects for all pool disks. The PhysicalDiskData objects are piped to the cmdlet Get-DcsMonitor where they are filtered by the State "Critical" (the state of a failed disk) and saved in the variable $FailedDisks. The MonitoredObjectId field in the saved objects stored in $FailedDisks is piped to the cmdlet Get-DcsPurgePrerequisites to get the prerequisite actions for the virtual disks affected by the failed disks. In this case, there is one failed disk.

Id                                                      AllocatedSizeOnDisk                   AllocatedSizeTotal                              Actions
--                                                      -------------------                   ------------------                              -------
af4a7c67d3484b02858d0849451e5ee5                                 6979321856                          13287555072                                 None
97cdc9be7747421da532c1f9a0c9c43e                                 4563402752                           9529458688 ...eleteSnapshots, SplitFailedMirror
001e75810bf24809bf98e1a7a416afee                                 7113539584                          11542724608                     SplitReplication
344410225d844622afd82e1f9d9023f4                                  268435456                            268435456          SplitMirrorAndDeleteCdpDisk
88d953cd90654f93a57c543ef2b00e56                                 4563402752                          10468982784                                 None
                                

To Table of Contents

NAME

Get-DcsRecordingEndpoint

SYNOPSIS

Returns the data for the recording endpoints. Each endpoint may be connected to a local DataCore Server or a remote SQL DataBase.

SYNTAX

Get-DcsRecordingEndpoint   [ -Endpoint <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns the data for the recording endpoints. Each endpoint may be connected to a local DataCore Server or remote SQL Server. The "Enabled" property determines if the user can modify the endpoint. One endpoint can be used from multiple (recording) sessions (for example both the "ChargeBackSession" and "UserRecordingSession").

PARAMETERS

-Endpoint<Object>
The RecordingEndpointData object, name or ID that identifies a recording endpoint. If a specific recording endpoint is not specified, all recording endpoints in the server group will be returned.

Required: false
Position: 1
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

RecordingEndpointData : Object that identifies and describes the recording endpoint, which represents the recording server, database, and gives the current state of the recording service for the database.

OUTPUTS

RecordingEndpointData : Object that identifies and describes the recording endpoint, which represents the recording server, database, and gives the current state of the recording service for the database.

NOTES

This cmdlet replaces the obsolete cmdlet Get-DcsRecordingServer. Also see Set-DcsRecordingEndpointProperties.

EXAMPLES

-------------- Example 1 Returns data for all recording endpoints in the server group. --------------

Get-DcsRecordingEndpoint

The cmdlet Get-DcsRecordingEndpoint is invoked without parameters to return all recording endpoints in the server group. Two objects are returned; one for the user-defined performance recording (configured by the user) and one for historical performance monitoring (assigned by the software).

CurrentState : Connected
Alias : !UserRecordingEndpoint
EndpointType : LocalDb
Readonly : False
Settings : DataCore.Executive.LocalRecordingEndpointSettings
SequenceNumber : 4175
Id : 7A46DCA6-85CA-4E52-9329-A2CD7C565B14
Caption : User recording endpoint
ExtendedCaption : User recording endpoint
Internal : False
     
CurrentState : Connected
Alias : !HistoricalMonitoringEndpoint
EndpointType : MultiPeriodLocalDb
Readonly : True
Settings : DataCore.Executive.LocalRecordingEndpointSettings
SequenceNumber : 3677
Id : EAC11308-BD78-4EFF-9CDD-C46AE4CED481
Caption : Historical monitoring recording endpoint
ExtendedCaption : Historical monitoring recording endpoint
Internal : False
     

To Table of Contents

NAME

Get-DcsRecordingInstance

SYNOPSIS

Returns the instances in the database to which the specified recording endpoint is connected at the moment. The instances can be used to retrieve performance data with Get-DcsRecordingPerformance.

SYNTAX

Get-DcsRecordingInstance   [ -StartTime <DateTime> ]   [ -EndTime <DateTime> ]   [ -Category <String> ]   [ -InstanceId <Object> ]   [ -Endpoint <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns the instances in the database to which the specified recording endpoint is connected at the moment. The instances can be used to retrieve performance data with Get-DcsRecordingPerformance. Filtering parameters may be specified to narrow the scope of the data returned. If no parameters are specified, data for all instances recorded in the "!UserRecordingEndpoint" will be returned."

PARAMETERS

-StartTime<DateTime>
The starting date and time of the performance recording. One way to provide the StartTime parameter would be to invoke New-Object with the TypeName parameter of DateTime with the correct arguments (see Help for New-Object, Get-Date). The StartTime parameter can also be provided in a string with the date and time. An example of the format is "Monday, December 3, 2012 2:00:00 PM". All instances which existed at or after the start time will be returned. This parameter can be used with the parameter EndTime to create a time frame.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-EndTime<DateTime>
The ending date and time of the performance recording. One way to provide the EndTime parameter would be to invoke New-Object with the TypeName parameter of DateTime with the correct arguments (see Help for New-Object, Get-Date). The StartTime parameter can also be provided in a string with the date and time. An example of the format is "Monday, December 3, 2012 4:00:00 PM". All instances which existed before or at the end time will be returned. This parameter can be used with the parameter StartTime to create a time frame.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Category<String>
The name of a category. If specified, only data for this category will be returned. Valid values for category names include: "DiskPool", "LogicalDisk", "Machine", "HostGroup", "PhysicalDisk", "PoolMember", "Replication", "RollbackGroup", "ScsiPort", "ServerGroup", "ServerMachine", "ServerScsiPort", "SharedDiskPool", "SharedPhysicalDisk", "SnapshotGroup", "SnapshotRelation", "StreamLogicalDisk", "VirtualDiskGroup", "VirtualDisk", "VirtualLogicalUnit", "VirtualTargetDevice", and "VirtualTargetDomain". Full category names are also supported, for instance "DiskPool" as well "DiskPoolPerformance".

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-InstanceId<Object>
The PerformanceInstanceData object or any other object, ID or name that identifies the instance that is being recorded. If specified only data for that instance will be returned. See example 4.

Required: false
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Endpoint<Object>
The RecordingEndpointData object, name or ID that identifies a recording endpoint. If the endpoint is not specified, statistics for the "!UserRecordingEndpoint" will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

PerformanceInstanceData or other object : The PerformanceInstanceData object identifies and describes the instance in a recording session. Any other object that identifies the instance that is being recorded may also be piped.

OUTPUTS

PerformanceInstanceData : Object identifying and describing the instance in a recording session.

NOTES

To get an instance for a physical disk not in a pool, use the PhysicalDiskId. To get an instance for a physical disk in a pool, use the PoolMemberId.In the returned PerformanceInstanceData object, the ActivityWindow field can be used to find the start and end dates of the data for an instance. Note: In the ActivityWindow object, the timestamp for Center, StateTime and EndTime fields will always reflect midnight on the correct day. See Example 2.See Example 4 which demonstrates how to use an instance to get recorded performance data and output the data to a CSV file.Also see Add-DcsRecordingPoint, Get-DcsRecordingPerformance, Get-DcsRecordingPoint, Get-DcsRecordingResolution, Get-DcsRecordingEndpoint, Get-DcsRecordingSession, Get-DcsRecordingStatistics

EXAMPLES

-------------- Example 1 Returns all instances during a specific time frame --------------

Get-DcsRecordingInstance -StartTime "Monday, December 3, 2012 3:15:00 PM" -EndTime "Monday, December 3, 2012 4:15:00 PM"

The cmdlet Get-DcsRecordingInstance is invoked with a start time of "Monday, December 3, 2012 3:15:00 PM" and ending time of "Monday, December 3, 2012 4:15:00 PM". This cmdlet returns all instances of resources which existed in the recording session between the start and end time. PerformanceInstanceData objects that fit the criteria are returned.

KeyData : DataCore.Executive.PerformanceInstanceKeyData
Alias :
Caption : Disk pool 1
ExtendedCaption : Disk pool 1 on SSVVM1
ActivityWindow : DataCore.Executive.TimeInterval
     
KeyData : DataCore.Executive.PerformanceInstanceKeyData
Alias :
Caption : Virtual disk 1 on SSVVM1
ExtendedCaption : Virtual disk 1 on SSVVM1
ActivityWindow : DataCore.Executive.TimeInterval
     

-------------- Example 2 Returns all instances for a specified category and finds the start and end time of an instance in the database --------------

$PoolInstances = Get-DcsRecordingInstance -Category DiskPool

$PoolInstances[0].ActivityWindow

The cmdlet is invoked to return all instances for the category "DiskPool" and the instances are stored in the variable $PoolInstances. The variable $PoolInstances is used to obtain the ActivityWindow data for the object which contains the start time and end time of the recorded data. Note: the EndTime field in the Activity Window will be at midnight on the last day of the instance in the recorded data. Note: In the ActivityWindow object, the timestamp for Center, StateTime and EndTime fields will always reflect midnight on the correct day.

KeyData : DataCore.Executive.PerformanceInstanceKeyData
Alias :
Caption : Disk pool 1
ExtendedCaption : Disk pool 1 on SSV1
ActivityWindow : DataCore.Executive.TimeInterval
     
KeyData : DataCore.Executive.PerformanceInstanceKeyData
Alias :
Caption : Disk pool 2
ExtendedCaption : Disk pool 2 on SSV2
ActivityWindow : DataCore.Executive.TimeInterval
     
     
Center : 6/19/2013 12:00:00 PM
Period : 139.00:00:00
IsValid : True
StartTime : 4/11/2013 12:00:00 AM
EndTime : 8/28/2013 12:00:00 AM
     

-------------- Example 3 Returns a specific instance for the specified endpoint --------------

Get-DcsRecordingInstance -InstanceId (Get-DcsClient -Client "HostVM1").Id -Endpoint "User recording endpoint"

The cmdlet is invoked with a value for the parameter InstanceId. The value is retrieved by invoking the cmdlet Get-DcsClient to get the ClientHostData object for the host named "HostVM1". The Id from the object is used as the instance value. The PerformanceInstanceData object for "HostVM1" is returned.

KeyData : DataCore.Executive.PerformanceInstanceKeyData
Alias :
Caption : HostVM1
ExtendedCaption : HostVM1
ActivityWindow : 9/3/2015 8:20:00 PM - 9/3/2015 8:30:00 PM
     

-------------- Example 4 Uses an instance to retrieve performance data for an object category --------------

$PoolInstances = Get-DcsRecordingInstance -Category DiskPool

$PoolInstances[0].ActivityWindow

Center    : 4/2/2014 2:17:01 PM
Period    : 00:45:57.3670000
IsValid   : True
StartTime : 4/2/2014 1:54:02 PM
EndTime   : 4/2/2014 2:40:00 PM

$StartTime = $PoolInstances[0].ActivityWindow.StartTime
$EndTime = $PoolInstances[0].ActivityWindow.EndTime
$Resolution = (New-TimeSpan -Minutes 10)
$RecPerf = Get-DcsRecordingPerformance -StartTime $StartTime -EndTime $EndTime -Instance $PoolInstances[0] -Resolution $Resolution
$RecPerf.PerformanceSeries | Export-Csv -Path C:\Example.csv

The cmdlet Get-DcsRecordingInstance is used to retrieve recorded disk pool instances and store them in the variable $PoolInstances. The ActivityWindow for the first instance is retrieved and displayed. The Start time from the Activity Window is stored in the variable $StartTime and the End Time from the Activity Window is stored in the variable $EndTime. A resolution of 12 hours is stored in the variable $Resolution. the cmdlet Get-DcsRecordingPerformance is used to get the recording data for every 12 hours between the start time and end time and the performance data is stored in the variable $RecPerf. The Performance Series in the variable $RecPerf is exported to a CSV file named Example.csv located in the C:\ path. Data for all recorded disk pool counters are in the file. An excerpt from the Example.csv file follows:

#TYPE DataCore.Executive.DiskPoolPerformance
"TotalBytesTransferred","TotalBytesRead","TotalBytesWritten","TotalBytesMigrated","TotalReads","TotalWrites","TotalOperations","BytesAllocated","BytesAvailable","BytesInReclamation","BytesTotal","PercentAllocated","PercentAvailable","TotalReadTime","TotalWriteTime","MaxReadTime","MaxWriteTime","MaxReadWriteTime","MaxPoolBytes","BytesReserved","BytesAllocatedPercentage","BytesReservedPercentage","BytesInReclamationPercentage","BytesAvailablePercentage","BytesOverSubscribed","CollectionTime","NullCounterMap"
"9253376","5824512","3428864","0","2602","1664","4266","2147483648","92288109772","0","106568876032","13","86","172271","1457","74","6","74","1108127332171776","12133282611","2","11","0","86","23125338724761","4/2/2014 2:00:00 PM","18446744073675997184"
"90112","90112","0","0","16","0","16","536870912","106032005120","0","106568876032","1","99","1684","0","96","0","96","1108127332171776","0","1","0","0","99","23197923672064","4/2/2014 2:10:00 PM","18446744073675997184"
"199680","196608","3072","0","48","6","54","590558003","105978318028","0","106568876032","1","99","214","30","3","0","3","1108127332171776","0","1","0","0","99","23197923672064","4/2/2014 2:20:00 PM","18446744073675997184"
"832150528","817792000","14358528","26172456960","19845","7011","26856","104233487564","15837691904","72074919936","192146099404","58","41","2275090","161310","1084","646","1096","1108127332171776","0","58","0","33","8","23112346448691","4/2/2014 2:30:00 PM","18446744073675997184"
"436641792","430460928","6180864","20267139072","9196","3018","12214","108000531797","51136954368","54402919082","213540405248","51","48","1510510","24018","1067","207","1067","1108127332171776","0","51","0","25","23","23090952142848","4/2/2014 2:40:00 PM","18446744073675997184"
                                

-------------- Example 5 Gets all disk pool instances for a server by passing the disk pool object --------------

Get-DcsPool -Server SSV1 | Get-DcsRecordingInstance

The cmdlet Get-DcsPool is invoked to get DiskPoolData objects for all pools on server SSV1. The objects are piped to the cmdlet Get-DcsRecordingInstance. In this case, there are recording instances in the recording database for two pools on SSV1: "Disk pool 1" and "SharedPool1".

KeyData : DataCore.Executive.PerformanceInstanceKeyData
Alias :
Caption : Disk pool 1
ExtendedCaption : Disk pool 1 on SSV1
ActivityWindow : DataCore.Executive.TimeInterval
     
KeyData : DataCore.Executive.PerformanceInstanceKeyData
Alias :
Caption : SharedPool1
ExtendedCaption : SharedPool1 on SSV1
ActivityWindow : DataCore.Executive.TimeInterval
     

To Table of Contents

NAME

Get-DcsRecordingPerformance

SYNOPSIS

Returns recorded performance data for a specific instance or counters.

SYNTAX

Get-DcsRecordingPerformance   -Instance <Object>   [ -StartTime <DateTime> ]   [ -EndTime <DateTime> ]   [ -Resolution <TimeSpan> ]   [ -Counter <String[]> ]   [ -Endpoint <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns recorded performance data for a specific instance or counters. Filtering parameters may be specified to narrow the scope of the data returned. If no parameters are specified, all data for the "!UserRecordingEndpoint" will be returned."

PARAMETERS

-Instance<Object>
The PerformanceInstanceData object or any other object, ID or name that identifies the instance that is being recorded. To resolve by name, the name must be unique to the server group. If the instance is specified, only data for that instance will be returned.

Required: true
Position: 1
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-StartTime<DateTime>
The starting date and time of the performance recording. One way to provide the StartTime parameter would be to invoke New-Object with the TypeName parameter of DateTime with the correct arguments (see Help for New-Object, Get-Date). The StartTime parameter can also be provided in a string with the date and time. An example of the format is "Monday, December 3, 2012 2:00:00 PM". All data which existed at or after the start time will be returned. This parameter can be used with the parameter EndTime to create a time frame.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-EndTime<DateTime>
The ending date and time of the performance recording. One way to provide the EndTime parameter would be to invoke New-Object with the TypeName parameter of DateTime with the correct arguments (see Help for New-Object, Get-Date). The StartTime parameter can also be provided in a string with the date and time. An example of the format is "Monday, December 3, 2012 4:00:00 PM". All data which existed at or before the end time will be returned. This parameter can be used with the parameter EndTime to create a time frame.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Resolution<TimeSpan>
The interval between each recording point in the recording session. For instance, if the resolution is 10 minutes, recorded data will be returned for every 10 minute interval. One way to provide the TimeSpan parameter would be by using New-TimeSpan with the correct arguments (see the Help for New-TimeSpan). The TimeSpan parameter value can also be provided in a string which represents the number of days, hours, minutes, seconds, and milliseconds in the past. For instance, if the timespan should be 10 minutes, the value would be "00.00:10:00.00000". Note: Data is recorded at a default rate of every 2 minutes, so the recording interval rate should be considered for the resolution value in order to get meaningful recording performance data returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Counter<String[]>
The name of one or more specific counters. To get counter names for an instance, use the cmdlet Get-DcsPerformanceCounter and pass the specific object that identifies the instance.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Endpoint<Object>
The RecordingEndpointData object, name or ID that identifies a recording endpoint. If the endpoint is not specified, statistics for the "!UserRecordingEndpoint" will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

PerformanceInstanceData or any object type that identifies an instance. : The PerformanceInstanceData object identifies and describes the instance in a recording session. Any other object that identifies the instance that is being recorded may also be piped.

OUTPUTS

PerformanceSeriesData : Object that identifies and describes the performance data.

NOTES

To get performance for a physical disk not in a pool, use the PhysicalDiskId for the instance. To get performance for a physical disk in a pool, use the PoolMemberId for the instance.See Example 4 which demonstrates how to use an instance to get recorded performance data and output the data to a CSV file.Also see Get-DcsRecordingInstance, Get-DcsRecordingPoint, Get-DcsRecordingResolution, Get-DcsRecordingEndpoint, Get-DcsRecordingSession, Get-DcsRecordingStatistics

EXAMPLES

-------------- Example 1 Returns data for a specified instance and at a specified resolution --------------

$Tspan = New-TimeSpan -Minutes 10

Get-DcsPool -Pool "Disk pool 1" | Get-Dcsrecordingperformance -Resolution $Tspan

The cmdlet New-TimeSpan is invoked to create a TimeSpan object with the time span of 10 minutes and store it in the variable $Tspan. The cmdlet Get-DcsPool is invoked with the pool parameter of "Disk pool 1" to return the object DiskPoolData for Disk pool 1. This object is piped to the cmdlet Get-DcsRecordingPerformance with the value of the parameter Resolution set to $Tspan. The object PerformanceSeriesData is returned with data at a resolution of 10 minutes.

InstanceKeyData                                              PerformanceSeries
---------------                                              -----------------
DataCore.Executive.PerformanceInstanceKeyData                 DataCore.Executive.DiskPoolPerformance, DataCore.Executive.DiskPoolPer...
                                

-------------- Example 2 Returns data for a specific start and end time --------------

Get-DcsRecordingPerformance -StartTime "Tuesday, February 12, 2013 11:50 AM" -EndTime "Tuesday, February 12, 2013 12:25:00 PM" -Resolution 00.00:10:00.00000 -Instance "Disk pool 1"

The Get-DcsRecordingPerformance cmdlet is invoked with a start time of "Tuesday, February 12, 2013 11:50 AM" and an end time of "Tuesday, February 12,
 2013 12:25:00 PM", with a resolution of 10 minutes for the instance "Disk pool 1". The object PerformanceSeriesData is returned which contains the data for "Disk pool 1" for the specified time frame using a resolution of 10 minutes.
InstanceKeyData                                                PerformanceSeries
---------------                                                -----------------
DataCore.Executive.PerformanceInstanceKeyData                  {DataCore.Executive.DiskPoolPerformance, DataCore.Executive.DiskPoolPer...
                                

-------------- Example 3 Returns data for specific counters --------------

$VD1Ctrs = Get-DcsRecordingPoint -Instance "Virtual disk 1"

Get-DcsRecordingPerformance -Instance "Virtual disk 1" -Counter $VD1Ctrs.counters

The cmdlet Get-DcsRecordingPoint is invoked to return the recording points for the instance "Virtual disk 1". The results are stored in the variable $VD1Ctrs. The cmdlet Get-DcsRecordingPerformance is invoked for the instance "Virtual disk 1" and counter parameter is given the value of the variable "$VD1Crs.counters" where the specific counters are stored for "Virtual disk 1". The PerformanceSeriesData object is returned.

InstanceKeyData                                             PerformanceSeries
---------------                                             -----------------
DataCore.Executive.PerformanceInstanceKeyData               {DataCore.Executive.VirtualDiskPerformance, DataCore.Exe...
                                

-------------- Example 4 Uses an instance to retrieve performance data for an object category --------------

$PoolInstances = Get-DcsRecordingInstance -Category DiskPool
$PoolInstances[0].ActivityWindow

Center    : 8/10/2013 12:00:00 AM
Period    : 6.00:00:00
IsValid   : True
StartTime : 8/7/2013 12:00:00 AM
EndTime   : 8/13/2013 12:00:00 AM

$StartTime = $PoolInstances[0].ActivityWindow.StartTime
$EndTime = $PoolInstances[0].ActivityWindow.EndTime
$Resolution = (New-TimeSpan -Hours 12)
$RecPerf = Get-DcsRecordingPerformance -StartTime $StartTime -EndTime $EndTime
 -Instance $PoolInstances[0] -Resolution $Resolution
$RecPerf.PerformanceSeries | Export-Csv -Path C:\Example.csv

The cmdlet Get-DcsRecordingInstance is used to retrieve recorded disk pool instances and stored in the variable $PoolInstances. The ActivityWindow for the first instance is retrieved and displayed. The Start time from the Activity Window is stored in the variable $StartTime and the End Time from the Activity Window is stored in the variable $EndTime. A resolution of 12 hours is stored in the variable $Resolution. the cmdlet Get-DcsRecordingPerformance is used to get the recording data for every 12 hours between the start time and end time and the performance data is stored in the variable $RecPerf. The Performance Series in the variable $RecPerf is exported to a CSV file named Example.csv located in the C:\ path. Data for all recorded disk pool counters are in the file. An excerpt from the Example.csv file follows:

#TYPE DataCore.Executive.DiskPoolPerformance
"TotalBytesTransferred","TotalBytesRead","TotalBytesWritten","TotalBytesMigrated","TotalReads","TotalWrites","TotalOperations","BytesAllocated","BytesAvailable","BytesInReclamation","BytesTotal","PercentAllocated","PercentAvailable","TotalReadTime","TotalWriteTime","MaxReadTime","MaxWriteTime","MaxReadWriteTime","MaxPoolBytes","BytesReserved","BytesAllocatedPercentage","BytesReservedPercentage","BytesInReclamationPercentage","BytesAvailablePercentage","BytesOverSubscribed","CollectionTime","NullCounterMap"
"0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","0","8/7/2013 12:00:00 AM","18446744073709551615"
"4504486400","3812809728","1245054464","0","678815","338046","1016861","42949672960","10200547328","0","53150220288","81","19","8678677","314593","65","5","66","1108127332171776","0","81","0","0","19","0","8/7/2013 12:00:00 PM","18446744073675997184"
"13315784192","11271298560","2044485632","0","2007382","998288","3005670","42949672960","10200547328","0","53150220288","81","19","26319872","910059","74","5","74","1108127332171776","0","81","0","0","19","0","8/8/2013 12:00:00 AM","18446744073675997184"
"55390927872","53090332672","2300595200","0","1200480","2720512","3920992","43005691003","55848109408","300392057","99154192470","46","53","14099141","4425856","56","7","59","1108127332171776","0","46","0","0","53","13892474748","8/8/2013 12:00:00 PM","18446744073675997184"
                                

To Table of Contents

NAME

Get-DcsRecordingPerformanceDescription

SYNOPSIS

Provides counter information for the specified object or performance category in the performance recording.

SYNTAX

Get-DcsRecordingPerformanceDescription   -Object <Object>   [ -Counters <String[]> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Get-DcsRecordingPerformanceDescription   [ -Category <String> ]   [ -Counters <String[]> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Provides counter information for the specified object or performance category in the performance recording. Data returned is the counter name, full name, truncated description, and type of counter. Information for specific counters can be specified to narrow the scope of the data returned; otherwise, information for all counters for the object or category will be returned. Note: Output is in default table format which truncates the counter description. To view the complete description, save the output to a variable and view the description for each entry, such as $result[0].Description or reformat the data (see examples).

PARAMETERS

-Object<Object>
The name, ID, or any data object that identifies the counters, including (but not limited to) PerformanceData object (see Get-DcsPerformanceCounter), InstanceRecordingPointData object (see Get-DcsRecordingPoint), or CategoryRecordingPointData object (see Get-DcsRecordingPoint). If the Counters parameter is not specified, all counter information for the object will be returned.

Required: true
Position: 1
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Counters<String[]>
A comma-separated list of counter names. If specified, information will only be provided for those counters. See Example 1.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Category<String>
The name of a performance category the identifies the counters. Valid values for category names include: "DiskPool", "LogicalDisk", "Machine", "HostGroup", "PhysicalDisk", "PoolMember", "Replication", "RollbackGroup", "ScsiPort", "ServerGroup", "ServerMachine", "ServerScsiPort", "SharedDiskPool", "SharedPhysicalDisk", "SnapshotGroup", "SnapshotRelation", "StreamLogicalDisk", "VirtualDiskGroup", "VirtualDisk", "VirtualLogicalUnit", "VirtualTargetDevice", and "VirtualTargetDomain". Full category names are also supported, for instance "DiskPool" as well "DiskPoolPerformance". If the Counters parameter is not specified, all counter information for the category will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

Object : Any data object that can identify the Object parameter that is used to identify the counters.

OUTPUTS

PerformanceTypeDescriptor : Counter information and description.

NOTES

Also see Get-DcsPerformanceCounter.

EXAMPLES

-------------- Example 1 Returns specific counter information for a specified pool by piping the DiskPoolData object --------------

Get-DcsPool -Pool "Disk pool 1" | Get-DcsRecordingPerformanceDescription -Counters TotalBytesTransferred, TotalBytesRead, TotalBytesWritten

The cmdlet Get-DcsPool is invoked to obtain the DiskPoolData object for the specified pool "Disk pool 1". The object is piped to the cmdlet Get-DcsRecordingPerformanceDescription. Information for the counters specified by the Counters parameter is returned.

Counter                       FullName                      Description                   Type
-------                       --------                      -----------                   ----
TotalBytesTransferred         Total Bytes Transferred / sec Displays the total bytes w... Delta
TotalBytesRead                Total Bytes Read / sec        Displays the total bytes r... Delta
TotalBytesWritten             Total Bytes Written / sec     Displays the total bytes w... Delta
                                

-------------- Example 2 Returns all counter information for a specified category --------------

Get-DcsRecordingPerformanceDescription -Category PoolMember | Format-Table Counter, Description -AutoSize -Wrap

The cmdlet Get-DcsRecordingPerformanceDescription is invoked with the Category value of "PoolMember" which returns all counter information for physical disks that are in disk pools. In this case, the output is selectively displayed on the screen by using the PowerShell cmdlet Format-Table to only show the counter name and the complete description and not display the additional data returned (FullName and Type).

Counter                 Description
-------                 -----------
BytesAllocated          Displays the amount of logical pool space allocated by the pool disk. This is an instantaneous count, not an average over a period of time.
BytesAvailable          Displays the amount of logical pool space that is available to be allocated to a particular pool disk. This is an instantaneous count, not an average over a period of time.
BytesInReclamation      Displays the amount of logical space being (re)initialized by pool disk. This is an instantaneous count, not an average over a period of a period of time.
BytesRecovered          Displays the total number of bytes recovered by the pool disk.
BytesRemainingToRecover Displays the remaining number of bytes that need to be recovered by the pool disk.
BytesTotalToRecover     Displays the total number of bytes that need to be recovered by the pool disk.
BytesMigrated           Displays the number of bytes per second that are migrated between different tiers.
                                

-------------- Example 3 Returns counter information by specifying the name of an object --------------

Get-DcsRecordingPerformanceDescription -Object "HostVM1"

The cmdlet Get-DcsRecordingPerformanceDescription is invoked with the name of a client host "HostVM1" as the value of the parameter object. All counter information for "HostVM1" is returned.

Counter                       FullName                      Description                   Type
-------                       --------                      -----------                   ----
TotalBytesTransferred         Total Bytes Transferred / sec Displays the total bytes w... Delta
TotalBytesRead                Total Bytes Read / sec        Displays the total bytes r... Delta
TotalBytesWritten             Total Bytes Written / sec     Displays the total bytes w... Delta
TotalOperations               Total Operations / sec        Displays the total write a... Delta
TotalReads                    Total Reads / sec             Displays the total read op... Delta
TotalWrites                   Total Writes / sec            Displays the total write o... Delta
                                

To Table of Contents

NAME

Get-DcsRecordingPoint

SYNOPSIS

Returns category or instance data for counters configured in the specified recording session (recording points).

SYNTAX

Get-DcsRecordingPoint   [ -Instance <Object> ]   [ -Session <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Get-DcsRecordingPoint   [ -Category <String> ]   [ -Session <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Get-DcsRecordingPoint   [ -OnlyInstances]   [ -Session <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Get-DcsRecordingPoint   [ -OnlyCategories]   [ -Session <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns category or instance data for counters configured in the specified recording session (recording points). Filtering parameters may be specified to narrow the scope of the data returned. If no parameters are specified, all category and instance data from the "!UserRecordingSession" will be returned. Note: When "All instances" for a category has been added to a recording session, the data is stored in the CategoryRecordingPointData object. When individual instances or counters have been added, the data is stored in the InstanceRecordingPointData object. To return data in a more user-friendly format use "Format-Table Category, InstanceId, Counters", see Example 1.

PARAMETERS

-Instance<Object>
The InstanceRecordingPointData object or any object which identifies the instance, as well as the ID or name of the instance. If specified only data for that instance will be returned.

Required: false
Position: 1
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Session<Object>
The PerformanceRecordingSessionData object, Id, or Caption that identifies the recording session. If the session is not specified, the "!UserRecordingSession" will used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Connection: Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Category<String>
The name of a category. If specified, only data for this category will be returned. Valid values for category names include: "DiskPool", "LogicalDisk", "Machine", "HostGroup", "PhysicalDisk", "PoolMember", "Replication", "RollbackGroup", "ScsiPort", "ServerGroup", "ServerMachine", "ServerScsiPort", "SharedDiskPool", "SharedPhysicalDisk", "SnapshotGroup", "SnapshotRelation", "StreamLogicalDisk", "VirtualDiskGroup", "VirtualDisk", "VirtualLogicalUnit", "VirtualTargetDevice", and "VirtualTargetDomain".

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-OnlyInstances<SwitchParameter>
Use this parameter to return recording points for individual instances and counters that are configured in a recording session.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-OnlyCategories<SwitchParameter>
Use this parameter to return recording points for categories with "all instances" configured in a recording session.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

InstanceRecordingPointData, CategoryRecordingPointData, or any object type that identifies an instance. : Object that identifies and describes a category or instance of a counter.

OUTPUTS

CategoryRecordingPointData or InstanceRecordingPointData : Object that identifies and describes a category or instance of a counter.

NOTES

Also see Get-DcsRecordingInstance, Get-DcsRecordingPerformance, Add-DcsRecordingPoint, Remove-DcsRecordingPoint, Get-DcsRecordingInstance, Get-DcsRecordingPerformance, Get-DcsRecordingResolution, Get-DcsRecordingEndpoint, Get-DcsRecordingSession, Get-DcsRecordingStatistics

EXAMPLES

-------------- Example 1 Returns all instance and category data for the recording session --------------

Get-DcsRecordingPoint | Format-Table Category, Instanceid, Counters

The cmdlet Get-DcsRecordingPoint is invoked without parameters to return all instance and category data for the recording session for the default connection. The output is formatted in a table.


-------------- Example 2 Returns data for a specific instance in a specific recording session --------------

Get-DcsRecordingPoint -Instance "HostVM1" -Session "User recording session"

The cmdlet Get-DcsRecordingPoint is invoked to get data for the instance "HostVM1" for the "User recording session" as defined in the PerformanceRecordingSessionData object. The InstanceRecordingPointData object for "HostVM1 in the recording session is returned.

InstanceId                                                  Counters
----------                                                  --------
c14ee231f735470195253a98961d5674
                                

-------------- Example 3 Returns data for a specific category --------------

Get-DcsRecordingPoint -Category DiskPool

The cmdlet Get-DcsRecordingPoint is invoked to return data for the category with the name "DiskPool". The CategoryRecordingPointData object for the disk pools configured in the recording session are returned.


-------------- Example 4 Returns data for all individual instances and counters that are configured in a recording session. --------------

Get-DcsRecordingPoint -OnlyInstances

The cmdlet is invoked with the parameter OnlyInstances to return all individual instances and counters that are configured in a recording session. In this case, one instance was configured with all counters and another instance was configured with specific counters.

InstanceId                                                  Counters
----------                                                  --------
0ffe95524f0b4d8d85a138b9a017fd45
b9bebf8a-1bb6-43a6-a335-83d4264271c1                        {TotalBytesRead, TotalBytesTransferred, TotalBytesWritte...
                                

-------------- Example 5 Returns data for all instances in a category that are configured in a recording session. --------------

Get-DcsRecordingPoint -OnlyCategories

The cmdlet is invoked with the parameter OnlyCategories to return the categories that were added with "all instances" to recording session. In this case, there are two categories with "all instances" and the specific counters that were added for each are displayed.


To Table of Contents

NAME

Get-DcsRecordingResolution

SYNOPSIS

Returns the resolution of the recording session.

SYNTAX

Get-DcsRecordingResolution   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns the resolution of the recording session. The resolution is the time interval between when the data is recorded.

PARAMETERS

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

TimeSpan : Object that describes the resolution.

NOTES

Also see Add-DcsRecordingPoint, Get-DcsRecordingInstance, Get-DcsRecordingPerformance, Get-DcsRecordingPoint, Get-DcsRecordingEndpoint, Get-DcsRecordingSession, Get-DcsRecordingStatistics

EXAMPLES

-------------- Example 1 Returns the resolution of the recording session --------------

Get-DcsRecordingResolution

The cmdlet Get-DcsRecordingResolution is invoked to return the time interval between when the performance data is recorded. The TimeSpan object is returned indicating that data is collected and recorded every 2 minutes.

Days : 0
Hours : 0
Minutes : 2
Seconds : 0
Milliseconds : 0
Ticks : 1200000000
TotalDays : 0.00138888888888889
TotalHours : 0.0333333333333333
TotalMinutes : 2
TotalSeconds : 120
TotalMilliseconds : 120000
     

To Table of Contents

NAME

Get-DcsRecordingServer

SYNOPSIS

THIS CMDLET IS OBSOLETE, use Get-DcsRecordingEndpoint.

SYNTAX

Get-DcsRecordingServer   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

THIS CMDLET IS OBSOLETE, use Get-DcsRecordingEndpoint.

PARAMETERS

-Connection<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

NOTES

EXAMPLES

To Table of Contents

NAME

Get-DcsRecordingSession

SYNOPSIS

Returns data for the specified recording session.

SYNTAX

Get-DcsRecordingSession   [ -Session <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns data for the specified recording session. Data includes resolution, collection set and the status of the recording.

PARAMETERS

-Session<Object>
The PerformanceRecordingSessionData object, Id, or Caption that identifies the performance recording session. If the session is not specified, all sessions will be returned.

Required: false
Position: 1
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

PerformanceRecordingSessionData : Object that identifies and describes a performance recording session.

OUTPUTS

PerformanceRecordingSessionData : Object that identifies and describes a performance recording session.

NOTES

This cmdlet replaces the obsolete cmdlet Get-DcsRecordingSessionObsolete. Also see Get-DcsRecordingStatistics, Get-DcsRecordingResolution, Get-DcsRecordingEndpoint, Get-DcsRecordingInstance, Get-DcsRecordingPerformance, Get-DcsRecordingPoint

EXAMPLES

-------------- Example 1 Returns data for the specified recording session. --------------

Get-DcsRecordingSession -Session "User recording session"

The cmdlet Get-DcsRecordingSession is invoked to retrieve the session data for the "User recording session" as defined in the Caption of the PerformanceRecordingSessionData object.

EndpointId : 7A46DCA6-85CA-4E52-9329-A2CD7C565B14
Alias : !UserRecordingSession
CollectionSet : {DataCore.Executive.CategoryRecordingPointData}
Running : True
Readonly : False
SequenceNumber : 456
Id : 70138D60-B267-452B-AE0B-49838F09676A
Caption : User recording session
ExtendedCaption : User recording session on User recording endpoint
Internal : False
     

To Table of Contents

NAME

Get-DcsRecordingSessionObsolete

SYNOPSIS

NOTE: THIS CMDLET IS OBSOLETE, use Get-DcsRecordingSession.

SYNTAX

Get-DcsRecordingSessionObsolete   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

NOTE: THIS CMDLET IS OBSOLETE, use Get-DcsRecordingSession.

PARAMETERS

-Connection<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

OUTPUTS

NOTES

This cmdlet was formerly named Get-DcsRecordingSession and was renamed to Get-DcsRecordingSessionObsolete, See the new Get-DcsRecordingSession.

EXAMPLES

To Table of Contents

NAME

Get-DcsRecordingStatistics

SYNOPSIS

Returns the statistics for the database to which the specified recording endpoint is connected at the moment.

SYNTAX

Get-DcsRecordingStatistics   [ -Endpoint <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns the statistics for the database to which the specified recording endpoint is connected at the moment. Statistics include timestamp of first and last record, name and the size of the database used by the recording endpoint, the total number of counters, samples, and instances, and more.

PARAMETERS

-Endpoint<Object>
The RecordingEndpointData object, name or ID that identifies a recording endpoint. If the endpoint is not specified, statistics for the "!UserRecordingEndpoint" will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

PerformanceRecordingSessionData : Object that identifies and describes a performance recording session.

OUTPUTS

PerformanceRecordingSessionData : Object that identifies and describes a performance recording session.

NOTES

Also see Get-DcsRecordingSession, Get-DcsRecordingInstance, Get-DcsRecordingPerformance, Get-DcsRecordingPoint, Get-DcsRecordingResolution, Get-DcsRecordingEndpoint

EXAMPLES

-------------- Example 1 Returns statistics for the recording session --------------

Get-DcsRecordingEndpoint -Endpoint "User recording endpoint" | Get-DcsRecordingStatistics

The cmdlet Get-DcsRecordingEndpoint is invoked to retrieve the RecordingEndpointData object for the "User recording endpoint" and pipes the results to the cmdlet Get-DcsRecordingStatistics to return the statistics of the specified recording session.

TotalCounters : 816
TotalSamples : 48
TotalInstances : 4
UsedSize : 2.69 MB
FirstRecord : 9/3/2015 8:20:00 PM
LastRecord : 9/3/2015 8:50:00 PM
DatabaseName : DcsPerf
MinimumResolution : 00:00:30
EndpointId : 7A46DCA6-85CA-4E52-9329-A2CD7C565B14
CurrentHostId : A9DF0027-4577-42ED-B98F-5F39CDFE248E
     

To Table of Contents

NAME

Get-DcsReplication

SYNOPSIS

Returns replication data. This operation can also be performed on a virtual disk group.

SYNTAX

Get-DcsReplication   [ -VirtualDisk <Object> ]   [ -Replication <String> ]   [ -ShowOnlyLocalSide]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Get-DcsReplication   [ -VirtualDiskGroup <Object> ]   [ -Replication <String> ]   [ -ShowOnlyLocalSide]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns replication data. This operation can also be performed on a virtual disk group. Filtering parameters may be specified to narrow the scope of the data returned. If no parameters are specified, all replications on all servers (local and remote) in the default connection will be returned.

PARAMETERS

-VirtualDisk<Object>
VirtualDiskData object, name, or ID that identifies the local virtual disk in a replication. If specified, only data for that virtual disk will be returned. The VirtualDiskData object can be obtained from Get-DcsVirtualDisk.

Required: false
Position: named
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Replication<String>
The Async Replication ID (from the AsyncReplicationData object), virtual disk name, or virtual disk ID that identifies a replication. If specified, only data for that replication will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-ShowOnlyLocalSide<SwitchParameter>
If this parameter is specified, only data for source virtual disks that are local for the connection will be returned.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection is used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-VirtualDiskGroup<Object>
VirtualDiskGroupData object, name or ID that identifies a virtual disk group. Use this parameter to get replication data for all eligible virtual disks in the virtual disk group. The VirtualDiskGroupData object can be obtained with Get-DcsVirtualDiskGroup.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

VirtualDiskData : Object that identifies and describes the virtual disk.

OUTPUTS

AsyncReplicationData : Object that identifies and describes the relationship between the source and destination virtual disks in a replication.

NOTES

Also see Get-DcsReplicationPartnerGroup, Get-ReplicationBufferFolder, Get-DcsVirtualDisk, Get-DcsVirtualDiskGroup.

EXAMPLES

-------------- Example 1 Returns local replications for a specified server by piping objects --------------

Get-DcsVirtualDisk -Server SSV1 -OnlyWithReplications | Get-DcsReplication -ShowOnlyLocalSide

The cmdlet Get-DcsVirtualDisk is used to obtain virtual disk objects for server "SSV1" that are involved with replication. Those objects are piped to Get-DcsReplication which returns data for the local side of those objects.

FirstServerId : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3
FirstVirtualDiskId : a2cd4ba379e74d45985f1782c7b88573
SecondServerId : a420399f-ab67-4f87-aed2-39690ae21a5f:BECCFDE2-EEFC-4A6F-B425-5DDF7704DE1B
SecondVirtualDiskId : ef276db503c14e82b285450154f62f14
IsActiveSide : True
ReplicationState : Active
FailureStatus : NoFailure
TransferStatus : Enabled
Paused : False
CheckpointSnapshotId :
AutoAsyncReplicationLicense : Enabled
OfflineInitializationSupported : True
InitializationType : Online
OfflineInitializationBuffer :
OfflineInitStatus : NoOfflineInit
InitializationFailureStatus : NoFailure
Id : 5615bb30-8c01-4086-a331-b83781f3448a
Caption : Virtual disk 1
ExtendedCaption : Virtual disk 1 on SSV3
Internal : False
     
FirstServerId : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3
FirstVirtualDiskId : d4c9888f18004dfabf9542036c1538f1
SecondServerId : a420399f-ab67-4f87-aed2-39690ae21a5f:BECCFDE2-EEFC-4A6F-B425-5DDF7704DE1B
SecondVirtualDiskId : cec88d7114ed4d2c98eb268c21e10c33
IsActiveSide : True
ReplicationState : Active
FailureStatus : NoFailure
TransferStatus : Enabled
Paused : False
CheckpointSnapshotId :
AutoAsyncReplicationLicense : Enabled
OfflineInitializationSupported : True
InitializationType : Offline
OfflineInitializationBuffer :
OfflineInitStatus : NoOfflineInit
InitializationFailureStatus : NoFailure
Id : 593dca01-9233-4a76-a11d-2f336d2570de
Caption : Virtual disk 2
ExtendedCaption : Virtual disk 2 on SSV3
Internal : False
     

-------------- Example 2 Returns data for a replication specified by virtual disk name --------------

Get-DcsReplication -VirtualDisk "Virtual disk 1"

Returns data for the replication associated with "Virtual disk 1". Local and remote sides are returned.

FirstServerId : A6EA4E77-BBFF-4F48-91CD-3987E81C1CB3
FirstVirtualDiskId : a2cd4ba379e74d45985f1782c7b88573
SecondServerId : a420399f-ab67-4f87-aed2-39690ae21a5f:BECCFDE2-EEFC-4A6F-B425-5DDF7704DE1B
SecondVirtualDiskId : ef276db503c14e82b285450154f62f14
IsActiveSide : True
ReplicationState : Active
FailureStatus : NoFailure
TransferStatus : Enabled
Paused : False
CheckpointSnapshotId :
AutoAsyncReplicationLicense : Enabled
OfflineInitializationSupported : True
InitializationType : Online