mirror of
https://git.openafs.org/openafs.git
synced 2025-01-31 13:38:01 +00:00
e3dfba8e6c
This is the initial conversion of the AFS Adminstrators Reference into POD for use as man pages. The man pages are now generated via pod2man from regen.sh so that only those working from CVS have to have pod2man available. The Makefile only installs. The pages have also been sorted out into pod1, pod5, and pod8 directories, making conversion to the right section of man page easier without maintaining a separate list and allowing for names to be duplicated between pod5 and pod1 or pod8 (which will likely be needed in a few cases). This reconversion is done with a new script based on work by Chas Williams. In some cases, the output is worse than the previous POD pages, but this is a more comprehensive conversion. This is only the first step, and this initial conversion has various problems. In addition, the file man pages that didn't have simple names have not been converted in this pass and will be added later. Some of the man pages have syntax problems and all of them have formatting errors. The next editing pass, coming shortly, will clean up most of the remaining mess.
209 lines
6.5 KiB
Plaintext
209 lines
6.5 KiB
Plaintext
=head1 NAME
|
|
|
|
backup addvolentry - Defines a volume entry in a volume set
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
B<backup addvolentry -name> <I<volume set name>> -server <I<machine name>>
|
|
B<-partition> <I<partition name>>
|
|
-volumes <I<volume name (regular expression)>>
|
|
[B<-localauth>] [B<-cell> <I<cell name>>] [-help]
|
|
|
|
B<backup addvole -n> <I<volume set name>> B<-s> <I<machine name>> -p <I<partition name>>
|
|
B<-v> <I<volume name (regular expression)>>
|
|
[B<-l>] [B<-c> <I<cell name>>] [-h]
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
The backup addvolentry command adds a volume entry definition to
|
|
the existing volume set named by the B<-name> argument. A
|
|
volume entry definition can match one or more volumes, depending on the
|
|
combination of the B<-server>, B<-partition>, and
|
|
B<-volumes> arguments.
|
|
|
|
For the B<-server> and -partition arguments, provide
|
|
either
|
|
|
|
=over 4
|
|
|
|
=item *
|
|
|
|
The name of one machine or partition
|
|
|
|
|
|
=item *
|
|
|
|
The metacharacter expression .* (period and asterisk),
|
|
which matches every machine name or partition name in the Volume Location
|
|
Database (VLDB).
|
|
|
|
|
|
=back
|
|
|
|
For the -volumes argument, specify a combination of alphanumeric
|
|
characters and one or more metacharacters to wildcard part or all of the
|
|
volume name. The B<Options> section lists the acceptable
|
|
metacharacters.
|
|
|
|
=head1 CAVEATS
|
|
|
|
It is best to issue this command in interactive mode. If issuing it
|
|
at the shell prompt, enclose any strings containing metacharacters in double
|
|
quotes, or escape the metacharacters with other delimiters, to prevent the
|
|
shell from interpreting them. Adding volume entries to a temporary
|
|
volume set is possible only within the interactive session in which the volume
|
|
set was created.
|
|
|
|
=head1 OPTIONS
|
|
|
|
=over 4
|
|
|
|
=item -name
|
|
|
|
Names the volume set to which to add this volume entry definition.
|
|
The volume set must already exist (use the B<backup addvolset> command
|
|
to create it).
|
|
|
|
=item -server
|
|
|
|
Defines the set of one or more file server machines that house the volumes
|
|
in the volume entry. Provide either one fully-qualified hostname (such
|
|
as B<fs1.abc.com>) or the metacharacter expression
|
|
B<.*> (period and asterisk), which matches all machine names in
|
|
the VLDB.
|
|
|
|
=item -partition
|
|
|
|
Defines the set of one or more partitions that house the volumes in the
|
|
volume entry. Provide either one complete partition name (such as
|
|
B</vicepa>) or the metacharacter expression B<.*>
|
|
(period and asterisk), which matches all partition names.
|
|
|
|
=item -volumes
|
|
|
|
Defines the set of one or more volumes included in the volume
|
|
entry. Specify the volumes by name, by using any combination of regular
|
|
alphanumeric characters and one or more of the following metacharacter
|
|
expressions:
|
|
L<(1)>
|
|
L<(1)>
|
|
|
|
=over 4
|
|
|
|
=item .
|
|
|
|
The period matches any single character.
|
|
|
|
=item *
|
|
|
|
The asterisk matches zero or more instances of the preceding
|
|
character. Combine it with any other alphanumeric character or
|
|
metacharacter.
|
|
|
|
=item [ ]
|
|
|
|
Square brackets around a list of characters match a single instance of any
|
|
of the characters, but no other characters; for example, B<[abc]>
|
|
matches a single B<a> or B<b> or B<c>, but not
|
|
B<d> or B<A>. This expression can be combined with the
|
|
asterisk.
|
|
|
|
=item ^
|
|
|
|
The caret, when used as the first character in a square-bracketed set,
|
|
designates a match with any single character I<except> the characters
|
|
that follow it; for example, B<[^a]> matches any single character
|
|
except lowercase B<a>. This expression can be combined with the
|
|
asterisk.
|
|
|
|
=item \
|
|
|
|
A backslash preceding any of the metacharacters in this list makes it
|
|
match its literal value only. For example, the expression
|
|
B<\.> (backslash and period) matches a single period,
|
|
B<\*> a single asterisk, and B<\\> a single backslash.
|
|
Such expressions can be combined with the asterisk (for example,
|
|
B<\.*> matches any number of periods).
|
|
|
|
=back
|
|
|
|
Perhaps the most common metacharacter expression is the period followed by
|
|
an asterisk (B<.*>). This expression matches any string
|
|
of any length, because the period matches any character and the asterisk means
|
|
any number of that character. As mentioned, it is the only acceptable
|
|
metacharacter expression for the B<-server> and B<-partition>
|
|
arguments. In a volume definition it can stand alone (in which case it
|
|
matches every volume listed in the VLDB), or can combine with regular
|
|
characters. The following example matches any volume name that begins
|
|
with the string B<user> and ends with B<backup>:
|
|
|
|
user.*backup
|
|
|
|
=item -localauth
|
|
|
|
Constructs a server ticket using a key from the local
|
|
B</usr/afs/etc/KeyFile> file. The B<backup> command
|
|
interpreter presents it to the Backup Server, Volume Server and VL Server
|
|
during mutual authentication. Do not combine this flag with the
|
|
B<-cell> argument. For more details, see the introductory
|
|
B<backup> reference page.
|
|
|
|
=item -cell
|
|
|
|
Names the cell in which to run the command. Do not combine this
|
|
argument with the B<-localauth> flag. For more details, see the
|
|
introductory B<backup> reference page.
|
|
|
|
=item -help
|
|
|
|
Prints the online help for this command. All other valid options
|
|
are ignored.
|
|
|
|
=back
|
|
|
|
=head1 EXAMPLES
|
|
|
|
The following command adds a volume entry to the volume set called
|
|
B<sys>. The entry matches all volumes on any machine or
|
|
partition whose names begin with the string B<sun4x_56> followed by a
|
|
period:
|
|
|
|
backup> addvolentry sys .* .* sun4x_56\..*
|
|
|
|
The following command adds a volume entry to the volume set called
|
|
B<fs2>, to match all volumes on the B</vicepb> partition of
|
|
file server machine B<fs2.abc.com>. Because it is
|
|
issued at the shell prompt, double quotes surround the metacharacters in the
|
|
B<-volumes> argument. (The command is shown here on two lines
|
|
only for legibility reasons.)
|
|
|
|
% backup addvolentry -name fs2 -server fs2.abc.com \
|
|
-partition /vicepb -volumes ".*"
|
|
|
|
The chapter in the I<IBM AFS Administration Guide> about
|
|
configuring the AFS Backup System presents additional examples as well as
|
|
advice on grouping volumes.
|
|
|
|
=head1 PRIVILEGE REQUIRED
|
|
|
|
The issuer must be listed in the /usr/afs/etc/UserList file on
|
|
every machine where the Backup Server is running, or must be logged onto a
|
|
server machine as the local superuser B<root> if the
|
|
B<-localauth> flag is included.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<backup(1)>,
|
|
L<backup_addvolset(1)>,
|
|
L<backup_delvolentry(1)>,
|
|
L<backup_delvolset(1)>,
|
|
L<backup_listvolsets(1)>
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
|
|
|
|
This documentation is covered by the IBM Public License Version 1.0. It was
|
|
converted from HTML to POD by software written by Chas Williams and Russ
|
|
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.
|