uicfg command

This command displays and configures the CMM user interface settings.

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 uicfg command errors for a list of error messages that are specific to the uicfg command.

Table 1. uicfg 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.

Function What it does Command Target (see paths in Command targets)
Display CMM user interface settings Displays the user interface settings for the CMM. Returned values indicate enabled or disabled status for the following interfaces:
  • -cim (common information model used by the optional Lenovo XClarity Administrator or Flex System Manager software)
  • -cli (command line)
  • -snmp
  • -tcm (TCP command mode)
  • -stcm (secure TCP command mode)
  • -web (web interface)
uicfg
Primary CMM:
  • mm[p]
  • mm[P]
  • mm[x]
  • where x is the primary CMM bay number.
Enable / disable command-line interface Enables or disables the CMM command-line interface (using Telnet or SSH).
Note: The Telnet interface will not be available if the CMM chassis security level is set to secure with the security command.
uicfg -cli state

where state is enabled or disabled .

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 / disable CIM Enables or disables the CMM common information model (CIM) interface used by the optional Lenovo XClarity Administrator or Flex System Manager software. uicfg -cim state

where state is enabled or disabled .

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 / disable SNMPv1 and SNMPv3 Enables or disables SNMPv1 and SNMPv3 connections to the CMM.
Note: SNMPv1 connections will not be available if the CMM chassis security level is set to secure with the security command.
uicfg -snmp state

where state is enabled or disabled .

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 or set number of TCP command mode connections Disable the TCP command mode (used by the optional Lenovo XClarity Administrator or Flex System Manager software) for the CMM, or explicitly set the maximum number of TCP command mode connections.
Note:
  • Any number of connections (1 through 20) displays a status of enabled. Zero connections displays a status of disabled.
  • Non-secure TCM command mode will not be available if the CMM chassis security level is set to secure with the security command.
uicfg -tcm port_mode

where port_mode is:

  • disabled (no connections)
  • enabled (1 connection)
  • a number between 0 and 20, inclusive, that indicates the maximum number of non-secure TCP session connections
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 or set number of secure TCP command mode connections Disable the secure TCP command mode (used by the optional Flex System Manager software) for the CMM, or explicitly set the maximum number of secure TCP command mode connections.
Note:
  • On a write operation, the maximum number of connections can be set explicitly (0-20), or it can be enabled (1 connection) or disabled (0 connections).
  • On a read operation, disabled means 0 connections, and enabled means 1 or more connections.
  • The total session count of TCM and STCM is limited to 20.
uicfg -stcm port_mode

where port_mode is:

  • disabled (no connections)
  • enabled (1 connection)
  • a number between 0 and 20, inclusive, that indicates the maximum number of secure TCP session connections
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 / disable web interface Enables or disables the CMM web interface. uicfg -web state

where state is enabled or disabled .

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 disable the common information model for the CMM, while the primary CMM in bay 1 is set as the persistent command environment, at the system:mm[1]> prompt, type

uicfg -cim disabled
To display the user interface configuration for the CMM, while CMM 1 is set as the persistent command environment, at the system:mm[1]> prompt, type
uicfg

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

system:mm[1]> uicfg -cim disabled
Warning: Communication using the common information model
has been disabled.
OK
system:mm[1]> uicfg
-cim disabled
-cli enabled
-stcm disabled
system:mm[1]>