man5-editing-pass-20051213
[openafs.git] / src / man / fs_getserverprefs.1
1 fs getserverprefs          AFS Commands       fs getserverprefs
2
3
4 NAME
5
6    fs  getserverprefs -- display  Cache  Manager's preferences
7
8                        for file server machines.
9
10
11    fs getserverprefs  [-file <dir/file path>]  [-numeric]
12    [-help]
13
14 ACCEPTABLE ABBREVIATIONS/ALIASES
15
16    fs gets  [-f <dir/file path>]  [-n]  [-h]
17
18    fs gp  [-f <dir/file path>]  [-n]  [-h]
19
20 DESCRIPTION
21
22    Displays the Cache Manager's  preferences  for  file  server
23    machines.    A preference consists of the name or IP address
24    of a file server machine followed by its "rank."   The  rank
25    is a positive integer in the range from 1 to 65,534.
26
27    A  file server machine's rank determines the Cache Manager's
28    preference for selecting it  when  the  Cache  Manager  must
29    access  a  ReadOnly  replica  that resides on it.  The Cache
30    Manager compares the rank of the  server  machine  with  the
31    ranks  of  other server machines that house the replica.  It
32    then attempts to access the replica on  the  server  machine
33    that has the lowest integer rank.
34
35    If  it  cannot  access  the  replica on the machine with the
36    lowest rank (possibly because the machine or the network  on
37    which  the  machine  is  located is down), the Cache Manager
38    attempts to access the replica from the server machine  with
39    the  next lowest rank.  It continues in this manner until it
40    either accesses the replica or determines that  all  of  the
41    file  server  machines  on  which  the  replica  resides are
42    unavailable.
43
44    The Cache Manager records addresses and ranks for all  local
45    file  server  machines.  It also records addresses and ranks
46    for all foreign file server machines that house a volume  it
47    has accessed or for which a rank has been specified with the
48    fs setserverprefs command.   It  stores  the  addresses  and
49    ranks in the kernel of the client machine.
50
51    Information displayed with this command is sent to stdout by
52    default.  The -file switch can be used to direct the  output
53    to a file.
54
55
56
57 ARGUMENTS
58
59    -file           specifies  the  pathname  of a file to which
60                    the file server machine names and ranks  are
61                    to  be written.  Omit this switch to display
62                    the machine names and ranks on stdout.
63
64    -numeric        specifies that the IP addresses of the  file
65                    server  machines  are to be displayed.  Omit
66                    this flag to display the names of  the  file
67                    server  machines.    Because  including this
68                    flag skips the resolution of IP addresses to
69                    machine names, information is displayed more
70                    quickly  than  if  the  option  is  omitted.
71                    (This  flag  is  especially  useful  if  the
72                    output is intended to be used  as  input  to
73                    the fs setserverprefs command, in which case
74                    it  does  not  matter   whether   names   or
75                    addresses are used.)
76
77    -help           prints   the  online  help  entry  for  this
78                    command.  Do not provide any other arguments
79                    or  flags with this one.  See section 3.1 in
80                    the Reference Manual for more details.
81
82 OUTPUT
83
84    The output displays a separate line  for  each  file  server
85    machine  that  has  a  rank  in the kernel of the machine on
86    which the command is issued.  Each line displays the name of
87    a file server machine followed by its rank, as follows:
88
89        first machine name            rank
90        second machine name           rank
91          .  .  .  .                  . .
92
93    If  the  -numeric  flag  is  included  with the command, the
94    output displays the IP addresses of the file server machines
95    instead  of  their  names.  The address of a machine is also
96    displayed if the Cache Manager cannot resolve a file  server
97    machine's  name  based  on the machine's address at the time
98    the command is issued.
99
100 EXAMPLES
101
102    The following displays the preferences  (the  list  of  file
103    server  machines and their respective ranks) associated with
104    a Cache Manager.  The output in the  example  truncates  the
105    complete  list of server machine names and ranks.  Note that
106    the IP addresses,  not  the  names,  of  some  machines  are
107    displayed because their addresses cannot be resolved.
108
109
110
111        % fs gets
112        fs5.transarc.com              20000
113        fs1.transarc.com              40000
114        fs3.transarc.com              20001
115        fs4.transarc.com              40001
116        fs2.transarc.com              25000
117        121.86.3.37                   40002
118        fserver1.andrew.cmu.edu       40000
119        121.86.3.34                   40001
120        server1.athena.mit.edu        1000
121           .   .   .   .   .           . .
122
123    The following displays the same Cache Manager's preferences,
124    but the -numeric flag is included to  display  only  the  IP
125    addresses of the file server machines, not their names.  The
126    example output again truncates the complete list  of  server
127    machine names and ranks.
128
129        % fs gets -n
130        128.21.6.214                  20000
131        128.2.11.9                    40000
132        128.2.11.12                   20001
133        128.2.11.13                   40001
134        128.2.11.11                   25000
135        121.86.3.37                   40002
136        121.86.3.31                   40000
137        121.86.3.34                   40001
138        145.2.50.121                  1000
139          .  .  .                      . .
140
141 PRIVILEGE REQUIRED
142
143    None.
144
145 MORE INFORMATION
146
147    fs setserverprefs