NAME

Get-DcsRecordingPoint

SYNOPSIS

Returns category or instance data for counters configured in the specified recording session (recording points).

SYNTAX

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

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

Get-DcsRecordingPoint [ -OnlyInstances] [ -Session <Object> ] [ -Connection <String> ] [ -PipelineVariable <String> ]

Get-DcsRecordingPoint [ -OnlyCategories] [ -Session <Object> ] [ -Connection <String> ] [ -PipelineVariable <String> ]

DESCRIPTION

Returns category or instance data for counters configured in the specified recording session (recording points). Filtering parameters may be specified to narrow the scope of the data returned. If no parameters are specified, all category and instance data from the "!UserRecordingSession" will be returned. Note: When "All instances" for a category has been added to a recording session, the data is stored in the CategoryRecordingPointData object. When individual instances or counters have been added, the data is stored in the InstanceRecordingPointData object. To return data in a more user-friendly format use "Format-Table Category, InstanceId, Counters", see Example 1.

PARAMETERS

-Instance<Object>: The InstanceRecordingPointData object or any object which identifies the instance, as well as the ID or name of the instance. If specified only data for that instance will be returned.; Required: false; Position: 1; Default value:; Accept pipeline input: true (ByValue); Accept wildcard characters: false
-Session<Object>: The PerformanceRecordingSessionData object, Id, or Caption that identifies the recording session. If the session is not specified, the "!UserRecordingSession" will used.; Required: false; Position: named; Default value:; Accept pipeline input: false; Accept wildcard characters: false
-Connection<String>: Connection: Alias of the connection to the server group. If not specified, the default connection will be used.; Required: false; Position: named; Default value:; Accept pipeline input: false; Accept wildcard characters: false
-PipelineVariable<String>: Required: false; Position: named; Default value:; Accept pipeline input: false; Accept wildcard characters: false
-Category<String>: The name of a category. If specified, only data for this category will be returned. Valid values for category names include: "DiskPool", "LogicalDisk", "Machine", "HostGroup", "PhysicalDisk", "PoolMember", "Replication", "RollbackGroup", "ScsiPort", "ServerGroup", "ServerMachine", "ServerScsiPort", "SharedDiskPool", "SharedPhysicalDisk", "SnapshotGroup", "SnapshotRelation", "StreamLogicalDisk", "VirtualDiskGroup", "VirtualDisk", "VirtualLogicalUnit", "VirtualTargetDevice", and "VirtualTargetDomain".; Required: false; Position: named; Default value:; Accept pipeline input: false; Accept wildcard characters: false
-OnlyInstances<SwitchParameter>: Use this parameter to return recording points for individual instances and counters that are configured in a recording session.; Required: false; Position: named; Default value:; Accept pipeline input: false; Accept wildcard characters: false
-OnlyCategories<SwitchParameter>: Use this parameter to return recording points for categories with "all instances" configured in a recording session.; Required: false; Position: named; Default value:; Accept pipeline input: false; Accept wildcard characters: false

INPUTS

InstanceRecordingPointData, CategoryRecordingPointData, or any object type that identifies an instance. : Object that identifies and describes a category or instance of a counter.

OUTPUTS

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

NOTES

Also see Get-DcsRecordingInstance, Get-DcsRecordingPerformance, Add-DcsRecordingPoint, Remove-DcsRecordingPoint, Get-DcsRecordingInstance, Get-DcsRecordingPerformance, Get-DcsRecordingResolution, Get-DcsRecordingEndpoint, Get-DcsRecordingSession, Get-DcsRecordingStatistics

EXAMPLES

-------------- Example 1 Returns all instance and category data for the recording session --------------

Get-DcsRecordingPoint | Format-Table Category, Instanceid, Counters

The cmdlet Get-DcsRecordingPoint is invoked without parameters to return all instance and category data for the recording session for the default connection. The output is formatted in a table.

-------------- Example 2 Returns data for a specific instance in a specific recording session --------------

Get-DcsRecordingPoint -Instance "HostVM1" -Session "User recording session"

The cmdlet Get-DcsRecordingPoint is invoked to get data for the instance "HostVM1" for the "User recording session" as defined in the PerformanceRecordingSessionData object. The InstanceRecordingPointData object for "HostVM1 in the recording session is returned.

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

-------------- Example 3 Returns data for a specific category --------------

Get-DcsRecordingPoint -Category DiskPool

The cmdlet Get-DcsRecordingPoint is invoked to return data for the category with the name "DiskPool". The CategoryRecordingPointData object for the disk pools configured in the recording session are returned.

-------------- Example 4 Returns data for all individual instances and counters that are configured in a recording session. --------------

Get-DcsRecordingPoint -OnlyInstances

The cmdlet is invoked with the parameter OnlyInstances to return all individual instances and counters that are configured in a recording session. In this case, one instance was configured with all counters and another instance was configured with specific counters.

InstanceId                                                  Counters
----------                                                  --------
0ffe95524f0b4d8d85a138b9a017fd45
b9bebf8a-1bb6-43a6-a335-83d4264271c1                        {TotalBytesRead, TotalBytesTransferred, TotalBytesWritte...

-------------- Example 5 Returns data for all instances in a category that are configured in a recording session. --------------

Get-DcsRecordingPoint -OnlyCategories

The cmdlet is invoked with the parameter OnlyCategories to return the categories that were added with "all instances" to recording session. In this case, there are two categories with "all instances" and the specific counters that were added for each are displayed.