NAME

Get-DcsRecordingPerformanceDescription

SYNOPSIS

Provides counter information for the specified object or performance category in the performance recording.

SYNTAX

Get-DcsRecordingPerformanceDescription -Object <Object> [ -Counters <String[]> ] [ -Connection <String> ] [ -PipelineVariable <String> ]

Get-DcsRecordingPerformanceDescription [ -Category <String> ] [ -Counters <String[]> ] [ -Connection <String> ] [ -PipelineVariable <String> ]

DESCRIPTION

Provides counter information for the specified object or performance category in the performance recording. Data returned is the counter name, full name, truncated description, and type of counter. Information for specific counters can be specified to narrow the scope of the data returned; otherwise, information for all counters for the object or category will be returned. Note: Output is in default table format which truncates the counter description. To view the complete description, save the output to a variable and view the description for each entry, such as $result[0].Description or reformat the data (see examples).

PARAMETERS

-Object<Object>: The name, ID, or any data object that identifies the counters, including (but not limited to) PerformanceData object (see Get-DcsPerformanceCounter), InstanceRecordingPointData object (see Get-DcsRecordingPoint), or CategoryRecordingPointData object (see Get-DcsRecordingPoint). If the Counters parameter is not specified, all counter information for the object will be returned.; Required: true; Position: 1; Default value:; Accept pipeline input: true (ByValue); Accept wildcard characters: false
-Counters<String[]>: A comma-separated list of counter names. If specified, information will only be provided for those counters. See Example 1.; Required: false; Position: named; Default value:; Accept pipeline input: false; Accept wildcard characters: false
-Connection<String>: Alias of the connection to the server group. If not specified, the default connection is used.; Required: false; Position: named; Default value:; Accept pipeline input: false; Accept wildcard characters: false
-PipelineVariable<String>: Required: false; Position: named; Default value:; Accept pipeline input: false; Accept wildcard characters: false
-Category<String>: The name of a performance category the identifies the counters. Valid values for category names include: "DiskPool", "LogicalDisk", "Machine", "HostGroup", "PhysicalDisk", "PoolMember", "Replication", "RollbackGroup", "ScsiPort", "ServerGroup", "ServerMachine", "ServerScsiPort", "SharedDiskPool", "SharedPhysicalDisk", "SnapshotGroup", "SnapshotRelation", "StreamLogicalDisk", "VirtualDiskGroup", "VirtualDisk", "VirtualLogicalUnit", "VirtualTargetDevice", and "VirtualTargetDomain". Full category names are also supported, for instance "DiskPool" as well "DiskPoolPerformance". If the Counters parameter is not specified, all counter information for the category will be returned.; Required: false; Position: named; Default value:; Accept pipeline input: false; Accept wildcard characters: false

INPUTS

Object : Any data object that can identify the Object parameter that is used to identify the counters.

OUTPUTS

PerformanceTypeDescriptor : Counter information and description.

NOTES

Also see Get-DcsPerformanceCounter.

EXAMPLES

-------------- Example 1 Returns specific counter information for a specified pool by piping the DiskPoolData object --------------

Get-DcsPool -Pool "Disk pool 1" | Get-DcsRecordingPerformanceDescription -Counters TotalBytesTransferred, TotalBytesRead, TotalBytesWritten

The cmdlet Get-DcsPool is invoked to obtain the DiskPoolData object for the specified pool "Disk pool 1". The object is piped to the cmdlet Get-DcsRecordingPerformanceDescription. Information for the counters specified by the Counters parameter is returned.

Counter                       FullName                      Description                   Type
-------                       --------                      -----------                   ----
TotalBytesTransferred         Total Bytes Transferred / sec Displays the total bytes w... Delta
TotalBytesRead                Total Bytes Read / sec        Displays the total bytes r... Delta
TotalBytesWritten             Total Bytes Written / sec     Displays the total bytes w... Delta

-------------- Example 2 Returns all counter information for a specified category --------------

Get-DcsRecordingPerformanceDescription -Category PoolMember | Format-Table Counter, Description -AutoSize -Wrap

The cmdlet Get-DcsRecordingPerformanceDescription is invoked with the Category value of "PoolMember" which returns all counter information for physical disks that are in disk pools. In this case, the output is selectively displayed on the screen by using the PowerShell cmdlet Format-Table to only show the counter name and the complete description and not display the additional data returned (FullName and Type).

Counter                 Description
-------                 -----------
BytesAllocated          Displays the amount of logical pool space allocated by the pool disk. This is an instantaneous count, not an average over a period of time.
BytesAvailable          Displays the amount of logical pool space that is available to be allocated to a particular pool disk. This is an instantaneous count, not an average over a period of time.
BytesInReclamation      Displays the amount of logical space being (re)initialized by pool disk. This is an instantaneous count, not an average over a period of a period of time.
BytesRecovered          Displays the total number of bytes recovered by the pool disk.
BytesRemainingToRecover Displays the remaining number of bytes that need to be recovered by the pool disk.
BytesTotalToRecover     Displays the total number of bytes that need to be recovered by the pool disk.
BytesMigrated           Displays the number of bytes per second that are migrated between different tiers.

-------------- Example 3 Returns counter information by specifying the name of an object --------------

Get-DcsRecordingPerformanceDescription -Object "HostVM1"

The cmdlet Get-DcsRecordingPerformanceDescription is invoked with the name of a client host "HostVM1" as the value of the parameter object. All counter information for "HostVM1" is returned.

Counter                       FullName                      Description                   Type
-------                       --------                      -----------                   ----
TotalBytesTransferred         Total Bytes Transferred / sec Displays the total bytes w... Delta
TotalBytesRead                Total Bytes Read / sec        Displays the total bytes r... Delta
TotalBytesWritten             Total Bytes Written / sec     Displays the total bytes w... Delta
TotalOperations               Total Operations / sec        Displays the total write a... Delta
TotalReads                    Total Reads / sec             Displays the total read op... Delta
TotalWrites                   Total Writes / sec            Displays the total write o... Delta