diff --git a/docs/source/guides/admin-guides/references/man1/rmdef.1.rst b/docs/source/guides/admin-guides/references/man1/rmdef.1.rst index f520916bc..06e4c474d 100644 --- a/docs/source/guides/admin-guides/references/man1/rmdef.1.rst +++ b/docs/source/guides/admin-guides/references/man1/rmdef.1.rst @@ -41,49 +41,62 @@ OPTIONS \ **-a|-**\ **-all**\ - Clear the whole xCAT database. A backup of the xCAT definitions should be saved before using this option. Once all the data is removed the xCAT daemon will no longer work. Most xCAT commands will fail. In order to use xCAT commands again, you have two options. You can restore your database from your backup by switching to bypass mode, and running the \ **restorexCATdb**\ command. You can switch to bypass mode by setting the XCATBYPASS environmant variable. (ex. "export XCATBYPASS=yes") A second option is to run \ **xcatconfig -d**\ . This will restore the initial setup of the database as when xCAT was initially installed. You can then restart xcatd and run xCAT commands. + Clear the whole xCAT database. A backup of the xCAT definitions should be saved before using this option as the xCAT daemons will no longer work once cleared. - - -\ **-f|-**\ **-force**\ + To restore: - Use this with the \ **-**\ **-all**\ option as an extra indicator that ALL definitions are to be removed. - - -\ **-h|-**\ **-help**\ + 1. \ **export XCATBYPASS=1**\ and run the \ **restorexCATdb**\ command. + + or + - Display a usage message. - - -\ *noderange*\ + 2. Run \ **xcatconfig -d**\ which initializes the database the same as when xCAT was installed. - A set of comma delimited node names and/or group names. See the "noderange" man page for details on supported formats. - - -\ **-o**\ \ *object-names*\ - A set of comma delimited object names. + \ **-f|-**\ **-force**\ + + Use this with the \ **-**\ **-all**\ option as an extra indicator that ALL definitions are to be removed. + - - -\ **-t**\ \ *object-types*\ - A set of comma delimited object types. + \ **-h|-**\ **-help**\ + + Display a usage message. + - - -\ **-C|-**\ **-cleanup**\ - Perform additional cleanup by running \ **nodeset offline**\ on the objects specified in the \ *noderange*\ . + \ *noderange*\ + + A set of comma delimited node names and/or group names. See the "noderange" man page for details on supported formats. + - - -\ **-V|-**\ **-verbose**\ - Verbose mode. + \ **-o**\ \ *object-names*\ + + A set of comma delimited object names. + + + + \ **-t**\ \ *object-types*\ + + A set of comma delimited object types. + + + + \ **-C|-**\ **-cleanup**\ + + Perform additional cleanup by running \ **nodeset offline**\ on the objects specified in the \ *noderange*\ . + + + + \ **-V|-**\ **-verbose**\ + + Verbose mode. + + diff --git a/xCAT-client/pods/man1/rmdef.1.pod b/xCAT-client/pods/man1/rmdef.1.pod index be44ccc73..0c3e8d58a 100644 --- a/xCAT-client/pods/man1/rmdef.1.pod +++ b/xCAT-client/pods/man1/rmdef.1.pod @@ -22,7 +22,17 @@ This command is used to remove xCAT object definitions that are stored in the xC =item B<-a|--all> -Clear the whole xCAT database. A backup of the xCAT definitions should be saved before using this option. Once all the data is removed the xCAT daemon will no longer work. Most xCAT commands will fail. In order to use xCAT commands again, you have two options. You can restore your database from your backup by switching to bypass mode, and running the B command. You can switch to bypass mode by setting the XCATBYPASS environmant variable. (ex. "export XCATBYPASS=yes") A second option is to run B. This will restore the initial setup of the database as when xCAT was initially installed. You can then restart xcatd and run xCAT commands. +Clear the whole xCAT database. A backup of the xCAT definitions should be saved before using this option as the xCAT daemons will no longer work once cleared. + +To restore: + +=over 5 + +=item 1. B and run the B command. + +or + +=item 2. Run B which initializes the database the same as when xCAT was installed. =item B<-f|--force>