DataCore Cmdlet Reference Guide

This page takes a few seconds to load in full.

A

NAME

Activate-DcsLicense

SYNOPSIS

Activates license keys for non-trial licenses.

SYNTAX

Activate-DcsLicense  -Keys<String> -Server <Object>   -ServerKey <String>   -CompanyName <String>   -ContactName <String>   -EmailAddress <String>   -PhoneNumber <String>   [ -Accept ]   [ -LicenseServer <String> ] [ -LicensePort <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 using either ways: single server keys, which requires the server and server keys parameters, server group keys, which requires group keys and capacity parameters or multiple keys, which requires the keys parameters to be provided.

PARAMETERS

-Keys<String>

An array of strings that repeats sets of strings, where the first string is a license key and the next string is an optional paramteter based on the specified type of key:

 

Group Capacity Key: A data size string, for instance "10 TB".

Server key: The server name.

Other (for instance BZ capacity): none

 

The key must be entered in the DataCore Management Console license activation page to view the applicable parameters that a key requires.

 

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

 

-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

-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

 

-LicensePort<String>

A string that is a port number. 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

INPUTS

ServerHostData : Object that identifies the server.

OUTPUTS

NOTES

EXAMPLES

$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
			

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
			

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

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

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

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

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

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

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> ] [<CommonParameters>]

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

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. "ESXi" if the client host is running VMware ESXi. "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. "Proxmox" if the client host is a Proxmox Virtual Environment. "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

 

-<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

ClientHostData : Object that identifies and describes the client host.

NOTES

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

EXAMPLES

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

NAME

Add-DcsDvaPoolDisk

SYNOPSIS

Uses the specified physical disk to increase Capacity Optimization storage available on the corresponding server.

SYNTAX

Add-DcsDvaPoolDisk -Server<String> [-DvaPool<String>] -Disk<Object> [-IsL2ARCDisk<Boolean>] [-Connection <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

DESCRIPTION

Uses the specified physical disk to increase Capacity Optimization storage available on the corresponding server.

PARAMETERS

-Server<String>

The Id of the server the Dva Pool Disk will be created on, extending Capacity Optimization storage.

Required: true

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-DvaPool<String>

The Id of the Dva Pool that the physical disk will be inserted.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Disk<Object>

The Id of the physical disk that will be used to extend Capacity Optimization storage.

Required: true

Position: named

Default value:

Accept pipeline input: false

 

-IsL2ARCDisk<Boolean>

Indicates if the physical disk will be used as read performance booster, this may improve Capacity Optimization performance.

Required: false

Position: named

Default value:

Accept pipeline input: 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

 

-InformationAction <ActionPreference>

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

 

-InformationVariable <String>

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

 

-<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216)

 

INPUTS

OUTPUTS

DvaPoolDiskData : Object that identifies and describes the DvaPool disk.

NOTES

EXAMPLES

Add-DcsDvaPoolDisk -Server SSVVM011 -Disk "{4d8e1dae-98d4-4797-a235-1305982d4afe}"

Add-DcsDvaPoolDisk -Server SSVVM011 -Disk "{4d8e1dae-98d4-4797-a235-1305982d4afe}"- IsL2ARCDisk $true

NAME

Add-DcsDvaPoolSpecialMirror

SYNOPSIS

Add Mirrored Special Device to Capacity Optimization.

SYNTAX

Add-DcsDvaPoolSpecialMirror -Server<String> [-DvaPool <String>] –MirrorDisks<Object[]> [-Connection <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

DESCRIPTION

Add a new Mirrored Special Device group to Capacity Optimization storage using the specified physical disks. For Mirrored Special Device, only 2 disks are supported.

PARAMETERS

-Server<String>

The Id of the server the Mirrored Special Device will be created on Capacity Optimization.

Required: true

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-DvaPool<String>

ID of the DvaPool.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-MirrorDisks<Object[]>

Array of Disk name or ID of physical disk. Only 2 disks are supported for Special Mirror.

Required: true

Position: named

Default value:

Accept pipeline input: 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

 

-InformationAction <ActionPreference>

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

 

-InformationVariable <String>

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

 

-<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216)

 

INPUTS

OUTPUTS

DvaPoolDiskData : Object that identifies and describes the DvaPool disk.

NOTES

EXAMPLES

Add-DcsDvaPoolSpecialMirror -Server SSVVM011 -MirrorDisks "{0a9497a2-b60e-4b96-b7fd-bb38912cd1dd}","{1e45d652-f5f6-463b-9ce0-798225fd9dbf}"

NAME

Add-DcsDvaRaidPoolDisks

SYNOPSIS

Add a new RAID 5 group to Capacity Optimization storage using the specified physical disks.

SYNTAX

Add-DcsDvaRaidPoolDisks -Server<String> [-DvaPool <String>] -PhysicalDisks <String[]> [-Connection <String>] [-InformationAction <ActionPreference>] [-InformationVariable <String>] [<CommonParameters>]

DESCRIPTION

Add a new RAID 5 group to Capacity Optimization storage using the specified physical disks.

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

-DvaPool<String>

The Id of the Dva Pool that the physical disk will be inserted.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-PhysicalDisks<String[]>

The Ids of the physical disks to create new RAID 5 group.

Required: true

Position: named

Default value:

Accept pipeline input: 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

 

-InformationAction <ActionPreference>

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

 

-InformationVariable <String>

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

 

-<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216)

INPUTS

OUTPUTS

DvaPoolDiskData : Object that identifies and describes the DvaPool disks.

NOTES

EXAMPLES

Add-DcsDvaRaidPoolDisks -Server SSVVM011 -PhysicalDisks "Disk4","Disk5","Disk6"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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> ] [<CommonParameters>]

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 1024 MB.

Required: false

Position: named

Default value: 1024

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

 

-<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

DiskPoolData : Object that identifies and describes the disk pool.

NOTES

Also see Get-DcsPool, Set-DcsPoolProperties.

EXAMPLES

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

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

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

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

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

$PM = Get-DcsPoolMember -Pool "Disk pool 1" -Disk "SSV1-WDC100-D1"
Add-DcsPoolMember -Pool $PM.DiskPoolId -PoolMember $PM -MirrorDisk "SSV1-WDC100-D2"
			

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

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

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

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

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

Add-DcsRecordingPoint -Category PhysicalDisk -Counter TotalOperations
		

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"
		

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

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

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

$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
		

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

$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]
		

$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
			

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

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

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

$remoteCred = Get-Credential
		

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

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
		

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] [-Compressed <Boolean>]  [ -DuplicateDiskId]   -TimeStamp <DateTime>   [ -AssignToCurrentUser]   [ -Connection <String> ]   [ -PipelineVariable <String> ] [<CommonParameters>]

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

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

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

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

 

-Compressed<Boolean>

Use this parameter to enable Inline Compression on the Rollback. Specifying as $True will enable the feature. It can only be enabled if the destination pool has Capacity Optimization enabled.

 

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

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

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

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

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

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

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

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> ] [-Compressed <Boolean>]  [ -DuplicateDiskId]   [ -AssignToCurrentUser]   [ -Connection <String> ]   [ -PipelineVariable <String> ] [<CommonParameters>]

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

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

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

 

-SnapshotGroupCreationProperties <Object []>

An array of SnapshotGroupCreationData, which is created from the cmdlet Get-DcsSnapshotGroupCreationProperties.

Required: true

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Full

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

-Compression <Boolean>

Use this parameter to enable Inline Compression on the Snapshot. Specifying as $True will enable the feature. It can only be enabled if the destination pool has Capacity Optimization enabled.

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

 

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).

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, Get-SnapshotGroupCreationProperties.

EXAMPLES

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

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

$snapshotGroupCreationProperties = Get-DcsSnapshotGroupCreationProperties -VirtualDiskGroup "Virtual disk group 1" $snapshotGroupCreationProperties | where  {$_.VirtualDiskId -eq "2317ff2f7f294f94ba462b244d4e7526"}).DestinationPoolId= "663204D9-B5F0-4251-9B9D-C0E8CE081456:{32bf0009-0ce6-11ee-9f8d-00155d026515}" $snapshotGroupCreationProperties | where  {$_.VirtualDiskId -eq "cffa9aa70a7a4ae9bbf6e97c14d95cce"}).Compression = $true Add-DcsSnapshot -VirtualDiskGroup "Virtual disk group 1" -SnapshotGroupCreationProperties $snapshotGroupCreationProperties -Full	

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

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

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

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

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

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

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

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

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

$Monitor = Get-DcsMonitor -Object (Get-DcsClient -Client "HostVM1")
Add-DcsTrigger -Task MonitorStateChange -MonitorId $Monitor.Id -MonitorState Healthy -Comparison ">"
		

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 

-FilterVirtualMachines<String>

This parameter helps the system to filter out any discovered virtual machines from the vCenter.

Required: false

Position: 6

Default value:

Accept pipeline input: false

Accept wildcard characters: false

 

-AutoUpdateTags<String>

When this parameter is enabled, the system automatically searches for Tags associated with the Datastores.

Required: false

Position: 7

Default value:

Accept pipeline input: false

Accept wildcard characters: false