This subcommand shows information about user CLI or GUI
sessions matching specified criteria.
About this task
ccm status -address ([-cli] | [-gui]) [-db|-database database_pattern]
[-u|-user username]
ccm status ([-cli] | [-gui]) [-db|-database database_pattern]
[-u|-user username] [-f|-format format] [-nf|-noformat]
([-ch|-column_header] | [-nch|-nocolumn_header])
[-sep|-separator separator]
([-sby|-sortby sortspec] | [-ns|-nosort|-no_sort])
[-gby|-groupby groupformat]
- -address
- Specifies to show the session address for each matching session
only. If a CLI session is running on the current client machine, you
might use this option as follows: export CCM_ADDR=‘ccm
status -address -cli‘
- -cli
- Specifies to show CLI sessions only.
- -ch|-column_header
- Specifies to use a column header in the output format. See -ch|-column_header for details.
- -db|-database database_pattern
- Specifies to show sessions running on databases that match the database_pattern only.
- If the database_pattern does
not contain any of the characters "/", "\", "*", "?", "[" or "]",
the pattern is used to match the end of the full database path (without
any trailing "/db" or "\db"). For example, for a database path of /ccmdb/example,
a database_pattern of example is
a match.
- Otherwise, the supplied database_pattern is
used as a shell matching pattern. A shell matching
pattern allows the use of "*" to match any (possibly zero length)
substring, and "?" to match any single character. With shell match
patterns, "*" matches the corresponding part of the path only. For
example, for a database path of /ccmdb/example, a
shell pattern of /*/example is a match. A shell
pattern of example is not a match.
- -f|-format format
- Specifies the command output format. See -f|-format for details.
- The following keywords are supported.
Table 1. Supported keywords for -format optionKeyword |
Description |
address |
The address of the session. |
current_session |
Has a boolean value of TRUE if the session is
the current session executing the command. |
database |
The path of the database used by the session. |
session |
The type of session such as "Command Interface"
or "Graphical Interface". |
username |
The name of the Synergy user who started the
session. |
- -gui
- Specifies to show GUI sessions only.
- -gby|-groupby groupformat
- Specifies how to group the command output. See -gby|-groupby for details.
- -nch|-nocolumn_header
- Specifies not to use a column header in the output format. See -nch|-nocolumn_header for details.
- -nf|-noformat
- Specifies not to use column alignment. See -nf|-noformat for details.
- -ns|-no_sort
- Specifies not to sort the command output. See -ns|-nosort for details.
- -sep|-separator separator
- Specifies a different separator character. See -sep|-separator for details.
- -sby|-sortby sortspec
- Specifies how to sort the command output. See -sby|-sortby for details.
- -u|-unnumbered
- Suppresses automatic numbering of the command output. See -u|-unnumbered for details.