]
Stop-StorageDiagnosticLog [-CimSession ] [-PassThru] [-ThrottleLimit ] []
DESCRIPTION
The Stop-StorageDiagnosticLog cmdlet stops the collection of Storage diagnostic logs. You can use the
Get-StorageDiagnosticInfo cmdlet to get the logs.
PARAMETERS
-CimSession []
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such
as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local
computer.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-PassThru []
Returns an object representing the item with which you are working. By default, this cmdlet does not generate
any output.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-StorageSubSystemFriendlyName
Specifies the friendly name of the Storage subsystem for which to gather storage diagnostics. It may denote
the Storage subsystem of the local computer (on which the cmdlet is run) or a remote Storage subsystem
(standalone or cluster).
Selecting the local subsystem:
-- On a standalone machine, no remote subsystems: All logs are gathered for that computer.
-- On a standalone machine, remote subsystems registered: All logs are gathered for the standalone machine,
including the client-side remoting calls.
-- On a cluster node: All logs for that particular cluster node are gathered, even ones that belong in the
cluster subsystem for that node only. None of the other nodes are logged.
Selecting the cluster subsystem:
-- All logs are gathered for each node in that cluster. This includes and logs or tracing that may correspond
to a node's local subsystem.
Selecting a remote subsystem:
-- Tracing and logs are only gathered for the remote endpoint. What logs and tracing are gathered depend on
whether it is a cluster or a standalone machine (see above cases).
-- Tracing and logs for the client-side operations (running on the management node) are not collected. It is
expected that if there is a failure, it is most likely in the remote subsystem.
In order to gather the client-side calls, you must also include the management node's local subsystem.
Required? true
Position? 1
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-StorageSubSystemName
Specifies the name of the Storage subsystem for which to gather Storage diagnostics. It may denote the Storage
subsystem of the local computer (on which the cmdlet is run) or a remote Storage subsystem (standalone or
cluster).
Selecting the local subsystem:
-- On a standalone machine, no remote subsystems: All logs are gathered for that computer.
-- On a standalone machine, remote subsystems registered: All logs are gathered for the standalone machine,
including the client-side remoting calls.
-- On a cluster node: All logs for that particular cluster node are gathered, even ones that belong in the
cluster subsystem for that node only. None of the other nodes are logged.
Selecting the cluster subsystem:
-- All logs are gathered for each node in that cluster. This includes and logs or tracing that may correspond
to a node's local subsystem.
Selecting a remote subsystem:
-- Tracing and logs are only gathered for the remote endpoint. What logs and tracing are gathered depend on
whether it is a cluster or a standalone machine (see above cases).
-- Tracing and logs for the client-side operations (running on the management node) are not collected. It is
expected that if there is a failure, it is most likely in the remote subsystem.
In order to gather the client-side calls, you must also include the management node's local subsystem.
Required? true
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-StorageSubSystemUniqueId
Specifies the unique ID of the Storage subsystem for which to gather Storage diagnostics. It may denote the
Storage subsystem of the local computer (on which the cmdlet is run) or a remote Storage subsystem (standalone
or cluster).
Selecting the local subsystem:
-- On a standalone machine, no remote subsystems: All logs are gathered for that computer.
-- On a standalone machine, remote subsystems registered: All logs are gathered for the standalone machine,
including the client-side remoting calls.
-- On a cluster node: All logs for that particular cluster node are gathered, even ones that belong in the
cluster subsystem for that node only. None of the other nodes are logged.
Selecting the cluster subsystem:
-- All logs are gathered for each node in that cluster. This includes and logs or tracing that may correspond
to a node's local subsystem.
Selecting a remote subsystem:
-- Tracing and logs are only gathered for the remote endpoint. What logs and tracing are gathered depend on
whether it is a cluster or a standalone machine (see above cases).
-- Tracing and logs for the client-side operations (running on the management node) are not collected. It is
expected that if there is a failure, it is most likely in the remote subsystem.
In order to gather the client-side calls, you must also include the management node's local subsystem.
Required? true
Position? named
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-ThrottleLimit []
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this
parameter is omitted or a value of 0 is entered, then Windows PowerShellr calculates an optimum throttle limit
for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies
only to the current cmdlet, not to the session or to the computer.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
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
Example 1: Stop Storage diagnostics
PS C:\>Start-StorageDiagnosticLog -StorageSubSystemName "TestCluster.contoso.corp.microsoft.com"
PS C:\> Stop-StorageDiagnosticLog -StorageSubSystemName "TestCluster.contoso.corp.microsoft.com
PS C:\> Get-StorageDiagnosticInfo -StorageSubSystemName "TestCluster.contoso.corp.microsoft.com -DestinationPath
C:\logs\techsupport
The first command starts the on-demand Storage diagnostic log session on a cluster subsystem.
The second command stops the diagnostic logs session.
The third command gets the diagnostic files and places them in C:\logs\techsupport.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=816497
Get-StorageDiagnosticInfo
Start-StorageDiagnosticLog