mmprotocoltrace command

Starts, stops, and monitors tracing for the CES protocols.

Synopsis

mmprotocoltrace start Identifier [Identifier...] [-c ClientIP] 
                      [-d Duration] [-l LogFileDir] [-N Nodes] [-f]

mmprotocoltrace stop [Identifier [Identifier...]]

mmprotocoltrace status [Identifier [Identifier...]] [-v]

mmprotocoltrace clear [Identifier [Identifier...]] [-f]

mmprotocoltrace reset Identifier [Identifier...]

mmprotocoltrace {config}

Availability

Available on all IBM Storage Scale editions.

Notice: This command has common function to other existing commands. As such, the function may, at any time in a future release, be rolled into other commands and immediately deprecated from use without prior notice. Information about the change and what commands replace it would be provided in some format at the time of that change. Users should avoid using this command in any type of automation or scripting or be advised a future change may break that automation without prior notice.

Description

Use the mmprotocoltrace command to trace Winbind, SMB, or network operations. You can start, stop, reset, or display the status of a trace with this command. It also controls the timeouts for the traces to avoid excessive logging.

Note: The protocol functions provided in this command, or any similar command, are generally referred to as CES (Cluster Export Services). For example, protocol node and CES node are functionally equivalent terms.

For more information about this command, see CES tracing and debug data collection.

Parameters

options

Specifies one of the following trace options:

-d Duration: Specifies the trace duration in minutes. The default is 10.
-l LogFileDir: Specifies the name of the directory that contains the log and tar files that are created by the trace. The directory name cannot be a shared directory. The default is a directory in /tmp/mmfs that is named by the trace type and time.
If the sudo wrapper mode is used, then the internal value for LogFileDir is set to the value that is configured for dataStructureDump in the IBM Storage Scale configuration using the mmlsconfig dataStructureDump command.
-N Nodes: Specifies a comma-separated list of names of the CES nodes where you want tracing to be done. The default is all the CES nodes. For more information, see Tips for using mmprotocoltrace.
-c ClientIPs: Specifies a comma-separated list of client IP addresses to trace. The CES nodes that you specified in the -N parameter will trace their connections with these clients. This parameter applies only to SMB traces and Network traces. For more information, see Tips for using mmprotocoltrace.
-f: Forces an action to occur. Affects the clear command. This parameter also disables prompt for smb and smbsyscalls.
-v: Verbose output. Affects only the status command.

command

Specifies one of the following trace commands:

start: Starts tracing for the specified component.
stop: Stops tracing for the specified component. If no component is specified, this option stops all active traces.
status: Displays the status of the specified component. If no component is specified, this option displays the status of all current traces.
config: Displays the protocol tracing configuration settings that are currently active for the node on which the command is run. For example, the limit for the maximal trace size. These settings are defined in the file /var/mmfs/ces/mmprotocoltrace.conf and are specific for each CES node.
clear: Clears the trace records from the trace list. If no component is specified, this option clears all current traces.
reset: Resets the nodes to the default state that is defined in the configuration file.

Identifier

Specifies one of the following components:

smb: Traces the SMB service. This enables a detailed tracing for incoming SMB connections from the specified SMB client IP addresses. When using this trace, it is recommended to only have few incoming connections from the specified IP addresses, as too many traced connections can impact the cluster performance.
network: Traces the Network service.
smbsyscalls: Collects the strace-logs for SMB. This collects a trace for all system calls issued from SMB connections from the specified SMB client IP addresses. When using this trace it is recommended to only have few incoming connections from the specified IP addresses, as too many traced connections can impact the cluster performance.
winbind: Traces the winbind service that is used for user authentication.

Exit status

0: Successful completion.
Nonzero: A failure occurred.

Security

You must have root authority to run the mmprotocoltrace command.

The node on which the command is run must be able to process remote shell commands on any other node in the cluster without the use of a password and without producing any extraneous messages. See the information about the requirements for administering a GPFS system in the IBM Storage Scale: Administration Guide.

Examples

To start an SMB trace, issue the following command:

[root@ces5040-41 ~]# mmprotocoltrace start smb -c 10.0.100.42,10.0.100.43

A sample output is as follows:

Starting traces for the given clients will stop their connections prior to tracing.
Open files on these connections might get corrupted so please close them first.
Do you really want to perform the operation? (yes/no - default no): yes
Setting up traces
Trace 'f5d75a67-621e-4f09-8d00-3f9efc4093f2' created successfully for 'smb'

Waiting for all participating nodes...

Trace ID:           f5d75a67-621e-4f09-8d00-3f9efc4093f2
State:              ACTIVE
Protocol:           smb
Start Time:         15:24:30 25/09/19
End Time:           15:34:30 25/09/19
Trace Location:     /tmp/mmfs/smb.20190925_152430.trc
Origin Node:        ces5040-41.localnet.com
Client IPs:         10.0.100.42, 10.0.100.43
Syscall:            False
Syscall Only:       False
Nodes:
      Node Name:            ces5040-41.localnet.com
      State:                ACTIVE

      Node Name:            ces5040-42.localnet.com
      State:                ACTIVE

      Node Name:            ces5040-43.localnet.com
      State:                ACTIVE

To stop the SMB trace, issue the following command:

[root@ces5040-41 ~]# mmprotocoltrace stop smb