remove obsolete inline documentation
This commit is contained in:
Dietmar Maurer
parent
86a545b4dc
commit
c7eb5a9ea3
@ -194,40 +194,3 @@ our $cmddef = {
|
||||
};
|
||||
|
||||
1;
|
||||
|
||||
__END__
|
||||
|
||||
=head1 NAME
|
||||
|
||||
pveam Tool to manage Linux Container templates on Proxmox VE
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
=include synopsis
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
pveam can manage Container templates like updating the Database,
|
||||
destroying, downloading and showing templates.
|
||||
This tool support bash completion
|
||||
|
||||
=head1 EXAMPLES
|
||||
|
||||
Updating the DB
|
||||
pveam update
|
||||
|
||||
downloading a template in background
|
||||
pveam download debian-8.0-standard --storage local --bg 1
|
||||
|
||||
removing a template
|
||||
pveam destroy debian-8.0-standard --storage local
|
||||
|
||||
showing all templates what are available
|
||||
pveam show
|
||||
|
||||
=head1 FILES
|
||||
|
||||
Log-files
|
||||
/var/log/pveam.log
|
||||
|
||||
=include pve_copyright
|
||||
|
||||
@ -173,19 +173,3 @@ our $cmddef = {
|
||||
};
|
||||
|
||||
1;
|
||||
|
||||
__END__
|
||||
|
||||
=head1 NAME
|
||||
|
||||
pveceph - tool to manage ceph services on pve nodes
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
=include synopsis
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
Tool to manage ceph services on pve nodes.
|
||||
|
||||
=include pve_copyright
|
||||
|
||||
@ -27,19 +27,3 @@ our $cmddef = {
|
||||
};
|
||||
|
||||
1;
|
||||
|
||||
__END__
|
||||
|
||||
=head1 NAME
|
||||
|
||||
pvesubscription - Proxmox VE subscription mamager
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
=include synopsis
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
This tool is used to handle pve subscriptions.
|
||||
|
||||
=include pve_copyright
|
||||
|
||||
@ -18,163 +18,3 @@ our $cmddef = [ 'PVE::API2::VZDump', 'vzdump', 'vmid', undef,
|
||||
}];
|
||||
|
||||
1;
|
||||
|
||||
__END__
|
||||
|
||||
=head1 NAME
|
||||
|
||||
vzdump - backup utility for virtual machine
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
=include synopsis
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
vzdump is an utility to make consistent snapshots of running virtual
|
||||
machines (VMs). It basically creates an archive of the VM private area,
|
||||
which also includes the VM configuration files. vzdump currently
|
||||
supports LXC containers and QemuServer VMs.
|
||||
|
||||
There are several ways to provide consistency (option C<mode>):
|
||||
|
||||
=over 2
|
||||
|
||||
=item C<stop> mode
|
||||
|
||||
Stop the VM during backup. This results in a very long downtime.
|
||||
|
||||
=item C<suspend> mode
|
||||
|
||||
For containers, this mode uses rsync to copy the VM to a temporary
|
||||
location (see option --tmpdir). Then the VM is suspended and a second
|
||||
rsync copies changed files. After that, the VM is started (resume)
|
||||
again. This results in a minimal downtime, but needs additional space
|
||||
to hold the VM copy.
|
||||
|
||||
For QemuServer, this mode will suspend the VM, start
|
||||
a live backup, and resume the VM.
|
||||
|
||||
=item C<snapshot> mode
|
||||
|
||||
For containers, this mode uses the snapshotting facilities of the underlying
|
||||
storage. A snapshot will be made of the container volume, and the snapshot content
|
||||
will be archived in a tar file.
|
||||
|
||||
For QemuServer, this mode will do a live backup similar to the C<snaphost> mode, but without
|
||||
suspending/resuming the VM.
|
||||
|
||||
=back
|
||||
|
||||
A technical overview of the Proxmox VE live backup for QemuServer can be found online at:
|
||||
https://git.proxmox.com/?p=pve-qemu-kvm.git;a=blob;f=backup.txt
|
||||
|
||||
=head1 BACKUP FILE NAMES
|
||||
|
||||
Newer version of vzdump encodes the virtual machine type and the
|
||||
backup time into the filename, for example
|
||||
|
||||
vzdump-lxc-105-2009_10_09-11_04_43.tar
|
||||
|
||||
That way it is possible to store several backup into the same
|
||||
directory. The parameter C<maxfiles> can be used to specify the maximal
|
||||
number of backups to keep.
|
||||
|
||||
=head1 RESTORE
|
||||
|
||||
The resulting archive files can be restored with the following programs.
|
||||
|
||||
=over 1
|
||||
|
||||
=item pct restore: Containers restore utility
|
||||
|
||||
=item qmrestore: QemuServer restore utility
|
||||
|
||||
=back
|
||||
|
||||
For details see the corresponding manual pages.
|
||||
|
||||
=head1 CONFIGURATION
|
||||
|
||||
Global configuration is stored in /etc/vzdump.conf.
|
||||
|
||||
tmpdir: DIR
|
||||
dumpdir: DIR
|
||||
storage: STORAGE_ID
|
||||
mode: snapshot|suspend|stop
|
||||
bwlimit: KBPS
|
||||
ionize: PRI
|
||||
lockwait: MINUTES
|
||||
stopwait: MINUTES
|
||||
size: MB
|
||||
maxfiles: N
|
||||
script: FILENAME
|
||||
exclude-path: PATHLIST
|
||||
|
||||
=head1 HOOK SCRIPT
|
||||
|
||||
You can specify a hook script with option C<--script>. This script is called at various phases of the backup process, with parameters accordingly set. You can find an example in the documentation directory (C<vzdump-hook-script.pl>).
|
||||
|
||||
=head1 EXCLUSIONS (Containers only)
|
||||
|
||||
vzdump skips the following files wit option --stdexcludes
|
||||
|
||||
/tmp/?*
|
||||
/var/tmp/?*
|
||||
/var/run/?*pid
|
||||
|
||||
You can manually specify exclude paths, for example:
|
||||
|
||||
# vzdump 777 --exclude-path /tmp/ --exclude-path '/var/foo*'
|
||||
|
||||
(only excludes tmp directories)
|
||||
|
||||
Configuration files are also stored inside the backup archive (/etc/vzdump), and will be correctly restored.
|
||||
|
||||
=head1 LIMITATIONS
|
||||
|
||||
VZDump does not save ACLs.
|
||||
|
||||
=head1 EXAMPLES
|
||||
|
||||
Simply dump VM 777 - no snapshot, just archive the VM private area and configuration files to the default dump directory (usually /vz/dump/).
|
||||
|
||||
# vzdump 777
|
||||
|
||||
Use rsync and suspend/resume to create an snapshot (minimal downtime).
|
||||
|
||||
# vzdump 777 --mode suspend
|
||||
|
||||
Backup all VMs and send notification mails to root and admin.
|
||||
|
||||
# vzdump --all --mode suspend --mailto root --mailto admin
|
||||
|
||||
Use LVM2 to create snapshots (no downtime).
|
||||
|
||||
# vzdump 777 --dumpdir /mnt/backup --mode snapshot
|
||||
|
||||
Backup more than one VM (selectively)
|
||||
|
||||
# vzdump 101 102 103 --mailto root
|
||||
|
||||
Backup all VMs excluding VM 101 and 102
|
||||
|
||||
# vzdump --mode suspend --exclude 101,102
|
||||
|
||||
Restore a container to a new VM 600
|
||||
|
||||
# pct restore 600 /mnt/backup/vzdump-lxc-777.tar
|
||||
|
||||
Restore a Qemu/KVM machine to VM 601
|
||||
|
||||
# qmrestore /mnt/backup/vzdump-qemu-888.vma 601
|
||||
|
||||
Clone an existing container 101 to a new container 300 with a 4GB root file system, using pipes
|
||||
|
||||
# vzdump 101 --stdout | pct restore --rootfs 4 300 -
|
||||
|
||||
=head1 SEE ALSO
|
||||
|
||||
pct(1), qmrestore(1)
|
||||
|
||||
=include pve_copyright
|
||||
|
||||
@ -66,19 +66,3 @@ our $cmddef = {
|
||||
};
|
||||
|
||||
1;
|
||||
|
||||
__END__
|
||||
|
||||
=head1 NAME
|
||||
|
||||
pvedaemon - the PVE configuration server
|
||||
|
||||
=include synopsis
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
All configuration is done using this Server. The Server only
|
||||
listens to a local address 127.0.0.1 port 85 for security
|
||||
reasons.
|
||||
|
||||
=include pve_copyright
|
||||
|
||||
@ -212,69 +212,3 @@ sub get_index {
|
||||
}
|
||||
|
||||
1;
|
||||
|
||||
__END__
|
||||
|
||||
=head1 NAME
|
||||
|
||||
pveproxy - the PVE API proxy server
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
=include synopsis
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
This is the REST API proxy server, listening on port 8006. This is usually
|
||||
started as service using:
|
||||
|
||||
# service pveproxy start
|
||||
|
||||
=head1 Host based access control
|
||||
|
||||
It is possible to configure apache2 like access control lists. Values are read
|
||||
from file /etc/default/pveproxy. For example:
|
||||
|
||||
ALLOW_FROM="10.0.0.1-10.0.0.5,192.168.0.0/22"
|
||||
DENY_FROM="all"
|
||||
POLICY="allow"
|
||||
|
||||
IP addresses can be specified using any syntax understood by Net::IP. The
|
||||
name 'all' is an alias for '0/0'.
|
||||
|
||||
The default policy is 'allow'.
|
||||
|
||||
Match | POLICY=deny | POLICY=allow
|
||||
---------------------------|-------------|------------
|
||||
Match Allow only | allow | allow
|
||||
Match Deny only | deny | deny
|
||||
No match | deny | allow
|
||||
Match Both Allow & Deny | deny | allow
|
||||
|
||||
=head1 SSL Cipher Suite
|
||||
|
||||
You can define the cipher list in /etc/default/pveproxy, for example
|
||||
|
||||
CIPHERS="HIGH:MEDIUM:!aNULL:!MD5"
|
||||
|
||||
Above is the default. See the ciphers(1) man page from the openssl
|
||||
package for a list of all available options.
|
||||
|
||||
=head1 Diffie-Hellman Parameters
|
||||
|
||||
You can define the used Diffie-Hellman parameters in /etc/default/pveproxy
|
||||
by setting DHPARAMS to the path of a file containing DH parameters in PEM
|
||||
format, for example
|
||||
|
||||
DHPARAMS="/path/to/dhparams.pem"
|
||||
|
||||
If this option is not set, the built-in 'skip2048' parameters will be used.
|
||||
|
||||
Note: DH parameters are only used if a cipher suite utilizing the DH key
|
||||
exchange algorithm is negotiated.
|
||||
|
||||
=head1 FILES
|
||||
|
||||
/etc/default/pveproxy
|
||||
|
||||
=include pve_copyright
|
||||
|
||||
@ -558,29 +558,8 @@ our $cmddef = {
|
||||
status => [ __PACKAGE__, 'status', [], undef, sub { print shift . "\n";} ],
|
||||
};
|
||||
|
||||
#my $cmd = shift;
|
||||
#PVE::CLIHandler::handle_cmd($cmddef, $0, $cmd, \@ARGV, undef, $0);
|
||||
#exit (0);
|
||||
|
||||
1;
|
||||
|
||||
__END__
|
||||
|
||||
=head1 NAME
|
||||
|
||||
pvestatd - PVE Status Daemon
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
=include synopsis
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
This daemom queries the status of VMs, storages and containers at
|
||||
regular intervals. The result is sent to all nodes in the cluster.
|
||||
|
||||
=include pve_copyright
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@ -80,28 +80,3 @@ our $cmddef = {
|
||||
};
|
||||
|
||||
1;
|
||||
|
||||
__END__
|
||||
|
||||
=head1 NAME
|
||||
|
||||
spiceproxy - SPICE proxy server for Proxmox VE
|
||||
|
||||
=head1 SYNOPSIS
|
||||
|
||||
=include synopsis
|
||||
|
||||
=head1 DESCRIPTION
|
||||
|
||||
SPICE proxy server for Proxmox VE. Listens on port 3128.
|
||||
|
||||
=head1 Host based access control
|
||||
|
||||
It is possible to configure apache2 like access control lists. Values are read
|
||||
from file /etc/default/pveproxy (see 'pveproxy' for details).
|
||||
|
||||
=head1 FILES
|
||||
|
||||
/etc/default/pveproxy
|
||||
|
||||
=include pve_copyright
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user