Skip to main content

tcpcmdmode command

This command displays and changes the timeout of the TCP command-mode sessions that are used by optional management devices, such as the Lenovo XClarity Administrator or Flex System Manager software, for out-of-band communication with the CMM. This command is also used to enable or disable the TCP command-mode sessions.

If command syntax is not correctly entered, or if a command fails to run, an error message is returned. See Common errors for a list of error messages that apply to all commands or tcpcmdmode command errors for a list of error messages that are specific to the tcpcmdmode command.

Table 1. tcpcmdmode command.

The command table is a multi-row, four-column table where each row describes a CMM CLI command option: column one lists command function, column two provides a detailed command description, column three shows command-option syntax, and column four lists valid command targets.

FunctionWhat it doesCommandTarget (see paths in Command targets)
Display TCP command-mode session status and timeoutDisplays the secure and non-secure TCP command-mode session status (maximum number of sessions) and timeout.tcpcmdmode
Primary CMM:
  • mm[p]
  • mm[P]
  • mm[x]
  • where x is the primary CMM bay number.
Set TCP command-mode session timeoutSets the secure and non-secure TCP command-mode session timeout value.tcpcmdmode -t timeout

where timeout is from 0 seconds (no timeout) to 4294967295 seconds, inclusive. If you enter a value outside this range, an error will be displayed.

This command can only be run by users who have one or more of the following command authorities:
  • Supervisor
  • Chassis configuration
See Commands and user authority for additional information.
Primary CMM:
  • mm[p]
  • mm[P]
  • mm[x]
  • where x is the primary CMM bay number.
Disable TCP command-mode sessionsDisables TCP command-mode sessions that are used by optional management devices for out-of-band communication with the CMM. This applies to both read and write operations.tcpcmdmode -status 0
This command can only be run by users who have one or more of the following command authorities:
  • Supervisor
  • Chassis configuration
See Commands and user authority for additional information.
Primary CMM:
  • mm[p]
  • mm[P]
  • mm[x]
  • where x is the primary CMM bay number.
Enable and set number of TCP command-mode sessionsEnables TCP command-mode and sets the maximum number of sessions that can be used by optional management devices for out-of-band communication with the CMM. For read operations, all of the values from 1 to 20, inclusive, mean enabled.
Note
  • The CMM supports a combined total of up to 20 secure and non-secure TCP command-mode sessions.
  • Non-secure TCP command-mode can not be enabled if the CMM chassis security level is set to secure with the security command.
tcpcmdmode -status number_sessions

where number_sessions is from 1 to 20, inclusive. (A value of 0 disables TCP command-mode sessions.) If you enter a value outside this range, an error will be displayed.

This command can only be run by users who have one or more of the following command authorities:
  • Supervisor
  • Chassis configuration
See Commands and user authority for additional information.
Primary CMM:
  • mm[p]
  • mm[P]
  • mm[x]
  • where x is the primary CMM bay number.
Disable secure TCP command-mode sessionsDisables secure TCP command-mode sessions that are used by optional management devices for out-of-band communication with the CMM. This applies to both read and write operations.tcpcmdmode -sstatus 0
This command can only be run by users who have one or more of the following command authorities:
  • Supervisor
  • Chassis configuration
See Commands and user authority for additional information.
Primary CMM:
  • mm[p]
  • mm[P]
  • mm[x]
  • where x is the primary CMM bay number.
Enable and set number of secure TCP command-mode sessionsEnables secure TCP command-mode and sets the maximum number of sessions that can be used by optional management devices for out-of-band communication with the CMM. For read operations, all of the values from 1 to 20, inclusive, mean enabled.
Note
The CMM supports a combined total of up to 20 secure and non-secure TCP command-mode sessions.
tcpcmdmode -sstatus number_sessions

where number_sessions is from 1 to 20, inclusive. (A value of 0 disables secure TCP command-mode sessions.) If you enter a value outside this range, an error will be displayed.

This command can only be run by users who have one or more of the following command authorities:
  • Supervisor
  • Chassis configuration
See Commands and user authority for additional information.
Primary CMM:
  • mm[p]
  • mm[P]
  • mm[x]
  • where x is the primary CMM bay number.
Example: To enable a maximum of five secure TCP command-mode sessions for the primary CMM, while the primary CMM in bay 1 is set as the persistent command environment, at the system:mm[1]> prompt, type
tcpcmdmode -sstatus 5
To set the TCP command-mode session timeout for the primary CMM to 6 minutes, while the primary CMM in bay 1 is set as the persistent command environment, at the system:mm[1]> prompt, type
tcpcmdmode -t 360
To display the TCP command-mode session status and timeout for the primary CMM, while the primary CMM in bay 1 is set as the persistent command environment, at the system:mm[1]> prompt, type
tcpcmdmode

The following example shows the information that is returned from these commands:

system:mm[1]> tcpcmdmode -sstatus 5
OK
system:mm[1]> tcpcmdmode -t 360
OK
system:mm[1]> tcpcmdmode
-sstatus 5 connections
-status 1 connection
-t 360 seconds
system:mm[1]>