Use the qptool lock
and qptool unlock
commands to take places in and out of service without stopping the server. Use the lock command to put places temporarily out of service during maintenance operations and then use the unlock command when the maintenance operations are complete.
When you have locked a place, a user trying to access that place receives a message that you specify.
commands lock places specified in the command automatically before running and then unlock the places when the operations are complete. However, you might want to lock a place before running multiple qptool
commands to prevent users from accessing the place until you have finished running the commands. For example, you might want to lock a place while using the qptool changemember
command to change several member names within the place to prevent members from accessing the place until all the name changes are complete.
When a place is locked, the only qptool
command you can run on it is qptool unlock
Enter the following command the server console to lock or unlock a place:
load qptool lock [unlock] arguments
are described in Table 1
Table 1. Arguments for qptool lock and qptool unlock
|-?||Prints help on the command.|
|-a||Locks/unlocks all places.|
|-p place(s) ||Specifies a place or a space-separated list of places to lock/unlock.|
|-message message ||Specifies a message to display to users who visit a locked place to indicate it is unavailable. Use quotes if the message contains spaces.|
|-i inputfile ||XML input file located in the server program directory that specifies the places to lock/unlock.|
|-o outputfile ||XML output file that logs the results of the command. By default the command logs results to qptool.lock.xml or qptool.unlock.xml in the server program directory.|
Note: To receive even more information during the lock/unlock process, you can set QuickPlaceLockLogging=1 in the notes.ini file.
Table 2 provides examples of the commands.
Table 2. Examples of qptool lock and qptool unlock
|Lock a place.|
load qptool lock -p placename -message "Place is undergoing membership changes. Please try back after 4 pm." (where placename is the name of the place being locked).
|Unlock a place.|
load qptool unlock -p placename
You also can lock and unlock places from Place Administration as described here: Locking and unlocking places
Parent topic: Managing places using My Places and qptool commands: qd85