NAME

Add-DcsRecordingPoint

SYNOPSIS

Adds counters to the specified recording session.

SYNTAX

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

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

DESCRIPTION

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

PARAMETERS

-Session<Object>: The PerformanceRecordingSessionData object, Id, or Caption that identifies the recording session. If the session is not specified, the "!UserRecordingSession" will used.; Required: false; Position: named; Default value:; Accept pipeline input: false; Accept wildcard characters: false
-Connection<String>: Alias of the connection to the server group. If not specified, the default connection will be used.; Required: false; Position: named; Default value:; Accept pipeline input: false; Accept wildcard characters: false
-Instance<Object>: Use this parameter to add an instance to the recording session. The value is the InstanceRecordingPointData object or any object which identifies the instance.; Required: true; Position: 1; Default value:; Accept pipeline input: true (ByValue); Accept wildcard characters: false
-Counter<String[]>: One or more specific counters to add to the recording session. A valid value is the name of the counter or a comma separated list of counters. To get counter names, use the cmdlet Get-DcsPerformanceCounter and pass the specific object; a list of counter names will be returned for the object.; Required: false; Position: 2; Default value:; Accept pipeline input: false; Accept wildcard characters: false
-PipelineVariable<String>: Required: false; Position: named; Default value:; Accept pipeline input: false; Accept wildcard characters: false
-Category<String>: Use this parameter to add a category to the recording session. Valid values for category names include: "DiskPool", "LogicalDisk", "Machine", "HostGroup", "PhysicalDisk", "PoolMember", "Replication", "RollbackGroup", "ScsiPort", "ServerGroup", "ServerMachine", "ServerScsiPort", "SharedDiskPool", "SharedPhysicalDisk", "SnapshotGroup", "SnapshotRelation", "StreamLogicalDisk", "VirtualDiskGroup", "VirtualDisk", "VirtualLogicalUnit", "VirtualTargetDevice", and "VirtualTargetDomain". Note: "Machine" refers to client host category and "ServerMachine" refers to server category. "ScsiPort" refers to client host SCSI ports category and "ServerScsiPort" refers to server SCSI ports category. "PoolMember" refers to physical disks in pools and "PhysicalDisk" refers to physical disks not in pools.; Required: true; Position: named; Default value:; Accept pipeline input: false; Accept wildcard characters: false

INPUTS

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

OUTPUTS

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

NOTES

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

EXAMPLES

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

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

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

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

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

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

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

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

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

Add-DcsRecordingPoint -Category PhysicalDisk -Counter TotalOperations

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

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

Get-DcsClient -Client HostVM1 | Get-DcsPerformanceCounter
TotalBytesTransferred : 0
TotalBytesRead        : 0
TotalBytesWritten     : 0
TotalOperations       : 0
TotalReads            : 0
TotalWrites           : 0
CollectionTime        : 4/10/2013 7:58:28 PM
NullCounterMap        : 0
Get-DcsClient -Client HostVM1 | Add-DcsRecordingPoint -Counter "TotalOperations", "TotalReads", "TotalWrites"

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