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]or
mmprotocoltrace stop <identifier> [<identifier>...] or
mmprotocoltrace status <identifier> [<identifier>...] [-v]or
mmprotocoltrace clear <identifier> [<identifier>...] [-f]or
mmprotocoltrace reset <identifier> [<identifier>...]or
mmprotocoltrace {config| check} Availability
Available with IBM Spectrum Scale™ Standard Edition or higher.
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.
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,
NFS, SMB, Object, or network operations.
You can start, stop, reset, check or, display the status of a trace with this command. It also
controls the timeouts for the traces to avoid excessive logging.
Winbind,
NFS, SMB, Object, or network operations.
You can start, stop, reset, check 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.
- -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.
- status
- Displays the status of the specified component.
- check
- Checks and performs all planned tracing actions specified on the node.
- config
- Displays the current contents of the configuration file.
- clear
- Clears the trace records from the trace list.
- reset
- Resets the nodes to the default state that is defined in the configuration file.
- identifier
- Specifies one of the following components:
- nfs
- Traces the NFS service.
- smb
- Traces the SMB service.
- object
- Traces the Object service.
- network
- Traces the Network service.
- smbsyscalls
- Collects the strace-logs for SMB.
- 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 Spectrum Scale: Administration Guide.
Examples
- To start an SMB trace, issue this command:
The system displays output similar to this:mmprotocoltrace start smb -c <clientIP>Trace 'fcb7cb07-c45e-43f8-8f1f-2de50cf15062' created successfully for 'smb' - To view the status of the SMB trace, issue this command:
The system displays output similar to this:mmprotocoltrace status smbTrace ID: fcb7cb07-c45e-43f8-8f1f-2de50cf15062 State: Active User ID: root Protocol: smb Start Time: 10:57:43 04/03/2016 End Time: 11:07:43 04/03/2016 Client IPs: 10.0.100.42, 10.0.100.43 Origin Node: ch-42.localnet.com Syscall: False Syscall Only: False Nodes: Node Name: ch-41.localnet.com State: ACTIVE Trace Location: /tmp/mmfs/smb.20160304_105742.trc Node Name: ch-42.localnet.com State: ACTIVE Trace Location: /tmp/mmfs/smb.20160304_105742.trc Node Name: ch-43.localnet.com State: ACTIVE Trace Location: /tmp/mmfs/smb.20160304_105742.trc - To stop the SMB trace, issue this command:
The system displays output similar to this:mmprotocoltrace stop smbStopping traces Trace 'fcb7cb07-c45e-43f8-8f1f-2de50cf15062' stopped for smb Waiting for traces to complete Waiting for node 'node1' Waiting for node 'node2' Waiting for node 'node3' Finishing trace 'fcb7cb07-c45e-43f8-8f1f-2de50cf15062' Successfully copied file from 'node1:/tmp/mmfs/smb.20160304_105742.trc' Successfully copied file from 'node2:/tmp/mmfs/smb.20160304_105742.trc' Successfully copied file from 'node3:/tmp/mmfs/smb.20160304_105742.trc' Trace tar file has been written to '/tmp/mmfs/smb.trace.20160304_105845.tar.gz - To clear the SMB trace from the trace file, issue this command:
The system displays output similar to this:mmprotocoltrace clear smbAll traces cleared successfully - To trace the systemcalls for SMB,
issue this command:
The system displays output similar to this:mmprotocoltrace smbsyscalls -c <clientIP>Trace '9cd534c9-be3c-4478-ba45-2e00acd4b544' created successfully for 'smb'