read command

This command restores the CMM configuration, including users and permission groups, that was previously saved to a file. It can also be used to unmanage the CMM after a failed or incomplete unmanage operation.

Configurations are saved to a file using the write command.

Note:
  • To successfully restore all settings using the read command, a user must have permission to modify any settings controlled by individual commands in the configuration being restored.
  • Restoring the CMM overwrites all existing user accounts and passwords on the CMM and the CMM IP address with the values in the backup file.
  • When a CMM is managed by an external management device, user management for CMM accounts is performed by that management device. User accounts and certificates on the CMM are locked, and the necessary certificates are not included in the CMM backup image, which will cause communications between the management device and the CMM to fail. See Remanaging CMM for information about re-managing a restored CMM.
  • When the CMM is set to "Secure" security mode, only secure file transfer methods, such as HTTPS and SFTP, can be used for tasks involving file transfer when the CMM is acting as a server. Unsecure file transfer protocols, such as HTTP, FTP, and TFTP, are disabled when the CMM is acting as a server when the security mode is set to "Secure". Unsecure file transfer protocols remain available for a CMM acting as a client for all commands when the security mode is set to "Secure".
  • For information about how to specify a URL for file transfer, see Specifying a URL for file transfer.

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

Table 1. read 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)
Restore CMM configuration from file Restores the CMM configuration from an image that was previously saved to a file.
Note:
  • This image includes CMM users and permission groups.
  • Password information stored in the configuration file is encrypted.
  • Users must have permission to modify any settings controlled by individual commands in the configuration being restored.
 read -u URL -p passphrase

where:

  • URL is fully qualified uniform resource locator, including file name, of the tftp, ftp, http, https, or sftp server where the configuration file is located.
  • "passphrase" is the double-quote delimited passphrase that was used to save the original configuration file. Minimum passphrase length is 6 characters. Maximum passphrase length is 31 characters.
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.
Restore CMM configuration from file (verbose) Restores the CMM configuration from an image that was previously saved to a file, showing the log file generated while doing the restore. The log file is not shown until the restore is complete, which might take several minutes.
Note:
  • This image includes CMM users and permission groups.
  • Password information stored in the configuration file is encrypted.
  • Users must have permission to modify any settings controlled by individual commands in the configuration being restored.
 read -u URL -p passphrase -v

where:

  • URL is fully qualified uniform resource locator, including file name, of the tftp, ftp, http, https, or sftp server where the configuration file is located.
  • "passphrase" is the double-quote delimited passphrase that was used to save the original configuration file. Minimum passphrase length is 6 characters. Maximum passphrase length is 31 characters.
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.
Restore CMM configuration from file and reset CMM Restores the CMM configuration from an image that was previously saved to a file and then reset the CMM.
Note:
  • This image includes CMM users and permission groups.
  • Password information stored in the configuration file is encrypted.
  • The CMM resets in all cases, even if restoring the configuration fails.
  • Users must have permission to modify any settings controlled by individual commands in the configuration being restored.
 read -u URL -p passphrase -r

where:

  • URL is fully qualified uniform resource locator, including file name, of the tftp, ftp, http, https, or sftp server where the configuration file is located.
  • "passphrase" is the double-quote delimited passphrase that was used to save the original configuration file. Minimum passphrase length is 6 characters. Maximum passphrase length is 31 characters.
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.
Restore CMM configuration from file (verbose) and reset CMM Restores the CMM configuration from an image that was previously saved to a file, showing the log file generated while doing the restore. The log file is not shown until the restore is complete, which might take several minutes, and displays for several seconds until the CMM resets.
Note:
  • This image includes CMM users and permission groups.
  • Password information stored in the configuration file is encrypted.
  • The CMM resets in all cases, even if restoring the configuration fails.
  • Users must have permission to modify any settings controlled by individual commands in the configuration being restored.
 read -u URL -p passphrase -v -r

where:

  • URL is fully qualified uniform resource locator, including file name, of the tftp, ftp, http, https, or sftp server where the configuration file is located.
  • "passphrase" is the double-quote delimited passphrase that was used to save the original configuration file. Minimum passphrase length is 6 characters. Maximum passphrase length is 31 characters.
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.
Unmanage CMM (forced) Unmanages the CMM after a failed or incomplete unmanage operation. read -f unmanage
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 restore the CMM configuration from an image previously saved to a file named cmm1.cfg in the temp directory on a TFTP server with an IP address of 9.37.177.215 and a passphrase of backuplock, while the Lenovo Flex System chassis is set as the persistent command environment, at the system> prompt, type 
read -u tftp://9.37.177.215/temp/cmm1.cfg -p "backuplock" -T mm[p]

The following example shows the information that is returned from this command:

system> read -u tftp://9.37.177.215/temp/cmm1.cfg -p "backuplock" -T mm[p]
OK
Configuration restore was successful
Restart the MM for the new settings to take effect
system>
To restore the CMM configuration from an image previously saved to a file named cfg.bkp in the /tftpboot/backup directory on a SFTP server with an IP address of 300.370.640.310, a user ID of userid, and a passphrase of Passphaase, while the Lenovo Flex System chassis is set as the persistent command environment, at the system> prompt, type 
read -u sftp://userid:password@300.370.640.310/tftpboot/backup/cfg.bkp 
-p "Passphaase" -T mm[p]

The following example shows the information that is returned from this command:

system> read -u sftp://userid:password@300.370.640.310/tftpboot/backup/cfg.bkp 
-p "Passphaase" -T mm[p]
OK
Configuration restore was successful
Restart the MM for the new settings to take effect
system>
Parent topic: Command reference