lsclient

Displays a list of clients that are currently being served by one or more metadata servers in the cluster.

Read syntax diagramSkip visual syntax diagram
>>-lsclient--+----------+--+-------------------------------+---->
             +- –?----+  |          .-default----------. |
             +- –h----+  '- –fmt--+-delim--character-+-'
             '- –help-'             '-xml--------------'

>--+----------------+--+-------------------+-------------------->
   |        .-off-. |  |           .-on--. |
   '- –p--+-on--+-'  '- –hdr --+-off-+-'

>--+---------------+--+----------------+--+-------+------------->
   '- –r--number-'  |        .-off-. |  +- –l-+
                      '- –v--+-on--+-'  '- –s-'

>--+----------------------+--+-------------------------+-------->
   '- –sess--session_id-'  '- –server--server_name-'

     .-------------.
     V             |
>--+---client_name-+-+-----------------------------------------><
   '- – -----------'

Parameters

–? | –h | –help
Displays a detailed description of this command, including syntax, parameter descriptions, and examples. If you specify a help option, all other command options are ignored.
–fmt
Specifies the format of the output. You can specify one of the following values:
default
Specify this value to display output in a tabular format using spaces as the delimiter between the columns. This is the default value. For example:
Client    Session ID   State     Server   Renewals   Privilege
==============================================================
jeko               1   Current   ST1            45   Standard
delim character
Specify this value to display output in a tabular format using the specified character to separate the columns. If you use a shell metacharacter (for example, * or \t) as the delimiting character, enclose the character in single quotation marks (') or double quotation marks ("). A blank space is not a valid character. For example:
jeko,1,Current,ST1,45,Standard
xml
Specify this value to display output using XML format, for example:
<IRETURNVALUE>
<INSTANCE CLASSNAME="STC_RegisteredFSClient">
<PROPERTY NAME="Name" TYPE="string"><VALUE TYPE="string">jeko</VALUE>
</PROPERTY>
<PROPERTY NAME="Id" TYPE="unit64"><VALUE TYPE="unit64">1</VALUE>
</PROPERTY>
<PROPERTY NAME="State" TYPE="unit16"><VALUE TYPE="unit16">1</VALUE>
</PROPERTY>
<PROPERTY NAME="SystemName" TYPE="string"><VALUE TYPE="string">ST1
</VALUE></PROPERTY>
<PROPERTY NAME="LeaseRenewals" TYPE="uint64"><VALUE TYPE="uint64">45
</VALUE></PROPERTY>
<PROPERTY NAME="IsPrivilege" TYPE="boolean"><VALUE TYPE="boolean">true
</VALUE></PROPERTY>
</INSTANCE>
</IRETURNVALUE>
–p
Specifies whether to display one page of text at a time or all text at once.
off
Displays all text at one time. This is the default value when the sfscli command is run in single-shot mode.
on
Displays one page of text at time. Pressing any key displays the next page. This is the default value when the sfscli command is run in interactive mode.
–hdr
Specifies whether to display the table header.
on
Displays the table header. This is the default value.
off
Does not display the table header.
–r number
Specifies the number of rows per page to display when the –p parameter is on. The default is 24 rows. You can specify a value from 1 to 100.
–v
Specifies whether to enable verbose mode.
off
Disables verbose mode. This is the default value.
on
Enables verbose mode.
–l
Displays additional information about each client.
–s
Displays default information about each client.
–sess session_id
Specifies the client-session ID to list. If not specified, this command displays a list of all clients.
–server server_name
Specifies the name of a metadata server to query for clients. If specified, this command displays only those clients that are served by the specified metadata server. If not specified, this command displays clients that are served by all metadata servers in the cluster.
client_name
Specifies the names of one or more clients to list. If not specified, this command displays all clients that are being served by the specified metadata server.
Specifies that you want to read the names of one or more clients to list from stdin (for example, – << /work/client_list.txt).

Description

If you run this command from an engine hosting a subordinate metadata server, you can display information about only the local metadata server. If you run this command from the engine hosting the master metadata server, client-server connections for the entire cluster are displayed.

Note: This command does not display a server as serving a client until the client accesses one of the filesets assigned to that server.
When you specify multiple parameters in this command, these behaviors apply:
  • Flags work as AND coordinators.
  • Objects work as OR coordinators.
  • When flags and objects are combined, they are listed in this manner:

    WHERE flag_1 AND flag_2 AND ... AND flag_n AND (object_1 OR object_2 OR ... OR object_m)

  • When flags or objects are not required and not specified, this command searches all possible values unless a default overrides this rule.
For example, if you specify –sess, –server, and two client names, the search would be performed in the following manner:

WHERE session_ID AND server_name AND (client_name_1 OR client_name_2)

If you do not specify a listing parameter, this command displays the following default information for each client:
  • Client name. This name is configured by the administrator on the client node.
  • Client-session ID. Each client can have one session running on each metadata server simultaneously.
  • State of the client. Possible states are:
    Current
    The client is currently being served by one of the metadata servers.
    Expired
    The client is not currently being served by one of the metadata servers.
  • Metadata server that is serving the client.
  • Number of renewals since the client-session was started.
  • Client privilege or access level. Possible privileges are:
    Root
    Indicates that the user has root privileges, and is considered a privileged user.
    Standard
    Indicates that the user has default access level.
If you specify the –s listing parameter, this command displays only the following information for each client:
  • Client name.
  • Client-session ID.
  • Metadata server that is serving the client.
If you specify the –l listing parameter, this command displays the following information in addition to the default information for each client:
  • Date and time of the last client-session renewal.
  • Time until the next client-session renewal is to occur, in seconds.
  • Client IP address.
  • Client port number.
  • Client operating-system platform.
  • Client file-system driver version.
  • Number of transactions started, per client session.
  • Number of transactions that have completed, per client session.
  • Number of session locks, per client session.
  • Number of data locks, per client session.
  • Number of byte-range locks, per client session.
Tip: The metadata server does not know which clients are connected to SAN File System. If you specify a client that is not connected, this command will return a warning that no rows were found.

Example

List clients The following example displays information about all clients currently being served by metadata server ST1:
sfscli> lsclient -server ST0,ST1

Client    Session ID         State   Server   Renewals   Privilege
==================================================================
client01  ABCD1234FBXC5678   Current   ST1          45   Standard
client02  ABCD1234FBXC5679   Current   ST1        1546   Root
client03  ABCD1234FBXC5670   Expired   ST0         587   Standard

Parent topic: Administrative commands

Related reference
addprivclient
reportclient
rmprivclient

Terms of use | Feedback
(C) Copyright IBM Corporation 2003, 2004. All Rights Reserved.