This commit was generated by cvs2svn to compensate for changes in r120,
[util-vserver.git] / man / vserver-copy.8
diff --git a/man/vserver-copy.8 b/man/vserver-copy.8
new file mode 100644 (file)
index 0000000..48e3cf2
--- /dev/null
@@ -0,0 +1,93 @@
+.TH "vserver-copy" "8" "0.3" "Mark Lawrence <nomad@null.net>" "System Administration"\r
+.SH "NAME"\r
+.LP \r
+vserver-copy \- copy/move a virtual server.\r
+.SH "SYNTAX"\r
+.LP \r
+vserver-copy [\fIoptions\fP] \fIvserver\fP \fInewname\fP \r
+.LP \r
+vserver-copy [\fIoptions\fP] \fIvserver\fP \fIhost\fP:[\fInewname\fP]\r
+.SH "DESCRIPTION"\r
+.LP \r
+vserver-copy makes a copy of a virtual server using rsync. It will\r
+rewrite the vserver.conf configuration file with the new hostname and\r
+IP information when given. If the destination name contains a host\r
+specification then ssh/rsh will be used for the data transfer.\r
+\r
+vserver-copy can used on a running vserver, although naturally the\r
+consistency of open database files and the like cannot be guaranteed.\r
+A running vserver can however be safely moved from one root host to another\r
+using the \-s flag.\r
+\r
+If downtime is an issue when moving a virtual server across hosts you\r
+should first run vserver without the \-s flag. This will pre\-populate the\r
+destination filesystem requiring only updates to be made on the next\r
+invocation.\r
+.SH "OPTIONS"\r
+.LP \r
+.TP \r
+\fB\-h\fR,\fB-\-help\fR\r
+output usage information and exit\r
+.TP \r
+\fB\-V\fR,\fB-\-version\fR\r
+output version information and exit\r
+.TP \r
+\fB\-v\fR,\fB-\-verbose\fR\r
+show all output (normally only informational messages and warnings)\r
+.TP \r
+\fB\-q\fR,\fB-\-quiet\fR\r
+suppress all output\r
+.TP \r
+\fB\-d\fR,\fB-\-domain\fR domain\r
+the new DNS domain when changing name. Overwrites /etc/hosts. Must be\r
+used with \-i\r
+.TP \r
+\fB\-i\fR,\fB-\-ip\fR address\r
+the new IP address when changing name. Overwrites /etc/hosts. Must be\r
+used with \-d\r
+.TP \r
+\fB\-r\fR,\fB-\-vsroot\fR\r
+directory containing virtual servers. Defaults to "/vserver"\r
+.TP \r
+\fB\-R\fR,\fB-\-rsh\fR\r
+use rsh instead of the default ssh for network transfer\r
+.TP\r
+\fB\-s\fR,\fB-\-stopstart\fR\r
+stop the virtual server before copying and start the new vserver afterwards.\r
+This really only makes sense if you are copying across root hosts and not\r
+changing names or IP addresses.\r
+.SH "FILES"\r
+.LP \r
+\fI/etc/vservers/vserver.conf\fP \r
+.SH "EXAMPLES"\r
+.LP \r
+# Copy a template vserver (same IP addresses etc)\r
+\r
+/usr/sbin/vserver-copy template web01\r
+\r
+# Copy webserver with change in configuration\r
+\r
+/usr/sbin/vserver-copy -i 192.168.5.62 -d example.com template web62\r
+\r
+# Move a running vserver to another roothost\r
+\r
+/usr/sbin/vserver-copy -s web62 roothost02:\r
+\r
+.SH "BUGS"\r
+.LP \r
+If a virtual server is moved from one root host to another a gratuitious\r
+ping should be sent to inform other devices on the local area network\r
+of the change in MAC address.\r
+\r
+Without this ping the devices will continue to attempt to reach the old\r
+MAC address for the length of their arp-cache timeout (10 minute default\r
+on Suns!).\r
+\r
+This functionality should probably be implmemented during the \r
+"vserver <name> start" process.\r
+.SH "AUTHOR"\r
+.LP \r
+Mark Lawrence <nomad@null.net>\r
+.SH "SEE ALSO"\r
+.LP \r
+vserver(8)\r