NAME

Remove-DcsRecordingPoint

SYNOPSIS

Removes a category, instance, or counter from the specified recording session (recording points).

SYNTAX

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

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

DESCRIPTION

Removes a category, instance, or counter from the specified recording session. Recording points must be removed in the same manner as they were added. For instance, when "All instances" for a category has been added, the category must be removed. Categories are stored in the CategoryRecordingPointData object. When individual instances or counters have been added, the instances must be removed. Instances are stored in the InstanceRecordingPointData object.

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>
The InstanceRecordingPointData object or any object which identifies the instance, as well as the ID or name of the instance to remove.

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

-Counter<String[]>
One or more counters to remove from the recording session. Multiple counters should be provided in a comma-separated list. Only the specified counters will be removed. (To get a list of counter names for an object, use the cmdlet Get-DcsPerformanceCounter and pass the specific object; a list of counters will be returned.)

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>
The category to remove from 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".

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

INPUTS

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

OUTPUTS

InstanceRecordingPointData : The object InstanceRecordingPointData identifies and describes an instance. This object will be returned if counters remain for the instance after one or more counters have been deleted.

NOTES

Also see Add-DcsRecordingPoint, Get-DcsRecordingPoint

EXAMPLES


-------------- Example 1 Removes specific counters for a specific instance --------------
Get-DcsClient -Client HostVM1 | Remove-DcsRecordingPoint -Counter TotalWrites, TotalReads, TotalOperations

The cmdlet Get-DcsClient is invoked with the parameter Client specified as "HostVM1". The results are piped to the cmdlet Remove-DcsRecordingPoint. Three counters are removed from the default recording session: TotalWrites, TotalReads, and TotalOperations. In this case, the updated InstanceRecordingPointData object is returned because the instance has other counters configured.

InstanceId                                                  Counters
----------                                                  --------
e829690c50df4c5fa978d5e48ca5bcf7                            {TotalBytesTransferred, TotalBytesWritten

-------------- Example 2 Removes a specific counter for all instances --------------
Remove-DcsRecordingPoint -Category PhysicalDisk -Counter TotalOperations

The cmdlet Remove-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 removed for all physical disk instances in the server group for the default session.

Category Counters
-------- --------
PhysicalDiskPerformance {TotalReads, TotalWrites}

-------------- Example 3 Removes all counters in all instances for a category --------------
Remove-DcsRecordingPoint -Category PhysicalDisk

The cmdlet Remove-DcsRecordingPoint is invoked with the single parameter Category and the value "PhysicalDisk". This results in all physical disk counters being removed for all physical disk instances in the server group for the default session.


-------------- Example 4 Removes all counters for a specific instance --------------
Get-DcsClient -Client HostVM1 | Remove-DcsRecordingPoint

The cmdlet Get-DcsClient is invoked with the parameter Client specified as "HostVM1". The results are piped to the cmdlet Remove-DcsRecordingPoint. This results in all counters for the instance "HostVM1" being removed from the default session.