doc/man-pages/pod/fs_setclientaddrs.pod

   1 =head1 NAME
   2
   3 fs setclientaddrs - Sets the client interfaces to register with the File Server
   4
   5 =head1 SYNOPSIS
   6
   7 fs setclientaddrs [B<-address> I<client network interfaces> [I<client network interfaces> ...]]  [B<-help>]
   8
   9 fs setcl [B<-a> I<client network interfaces> [I<client network interfaces> ...]]  [B<-h>]
  10
  11 fs sc [B<-a> I<client network interfaces> [I<client network interfaces> ...]]  [B<-h>]
  12
  13 =head1 DESCRIPTION
  14
  15 The C<fs setclientaddrs> command defines the IP addresses of the
  16 interfaces that the local Cache Manager registers with a File Server
  17 when first establishing a connection to it.
  18
  19 The File Server uses the addresses when it initiates a remote
  20 procedure call (RPC) to the Cache Manager (as opposed to responding to
  21 an RPC sent by the Cache Manager). There are two common circumstances
  22 in which the File Server initiates RPCs: when it breaks callbacks and
  23 when it pings the client machine to verify that the Cache Manager is
  24 still accessible.
  25
  26 The list of interfaces specified with this command replaces the list
  27 that the Cache Manager constructs and records in kernel memory as it
  28 initializes. At that time, if the file B</usr/vice/etc/NetInfo> exists on
  29 the client machine's local disk, the Cache Manager uses its contents
  30 as the basis for the list of interfaces addresses. If the file does
  31 not exist, the Cache Manager instead uses the network interfaces
  32 configured with the operating system. It then removes from the list
  33 any address included in the local B</usr/vice/etc/NetRestrict> file. It
  34 records the final list in kernel memory. (An administrator must create
  35 the B<NetInfo> and B<NetRestrict> files; there are no default versions of
  36 them.)
  37
  38 If an RPC to that interface fails, the File Server simultaneously
  39 sends RPCs to all of the other interfaces in the list, to learn which
  40 of them are still available. Whichever interface replies first is the
  41 one to which the File Server then sends pings and RPCs to break
  42 callbacks.
  43
  44 To list the interfaces that the Cache Manager is currently registering
  45 with File Servers, use the C<fs getclientaddrs> command.
  46
  47 =head1 OPTIONS
  48
  49 =over 4
  50
  51 =item B<-address> I<client network interfaces> [I<client network interfaces> ...]
  52
  53 Specifies each IP address to place in the list of interfaces,
  54 in dotted decimal format. Hostnames are not acceptable.
  55 Separate each address with one or more spaces.
  56
  57 =item B<-help>
  58
  59 Prints the online help for this command. All other valid
  60 options are ignored.
  61
  62 =back
  63
  64 =head1 OUTPUT
  65
  66 The message:
  67
  68 Adding I<interface>
  69
  70 confirms that each new interface was added to the Cache Manager's
  71 list. The address appears in hexadecimal format to match the notation
  72 used in the File Server log, B</usr/afs/logs/FileLog>.
  73
  74 =head1 EXAMPLES
  75
  76 The following example sets the two interfaces that the Cache Manager
  77 registers with File Servers.
  78
  79     fs setclientaddrs 191.255.105.68 191.255.108.84
  80    Adding 0xbfff6944
  81    Adding 0xbfff6c54
  82
  83 =head1 PRIVILEGE REQUIRED
  84
  85 The issuer must be logged in as the local superuser B<root>.
  86
  87 =head1 CAVEATS
  88
  89 The list specified with this command persists in kernel memory only
  90 until the client machine reboots. To preserve it across reboots,
  91 either list the interfaces in the local B</usr/vice/etc/NetInfo> file, or
  92 place the appropriate C<fs setclientaddrs> command in the machine's AFS
  93 initialization script.
  94
  95 Changes made with this command do not propagate automatically to File
  96 Servers to which the Cache Manager has already established a
  97 connection. To force such File Servers to use the revised list, either
  98 reboot each file server machine, or change the B<NetInfo> file and reboot
  99 the client machine.
 100
 101 The C<fs> command interpreter verifies that each of the addresses
 102 specified as a value for the B<-address> argument is actually configured
 103 with the operating system on the client machine. If it is not, the
 104 command fails with an error message that marks the address as a
 105 Nonexistent interface.
 106
 107 =head1 COPYRIGHT
 108
 109 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 110
 111 Converted from html to pod by Alf Wachsmann <alfw@slac.stanford.edu>, 2003,
 112 and Elizabeth Cassell <e_a_c@mailsnare.net>, 2004,
 113 Stanford Linear Accelerator Center, a department of Stanford University.
 114
 115 =head1 SEE ALSO
 116
 117 L<NetInfo_client_version(1)>,
 118 L<NetRestrict_client_version(1)>,
 119 L<fileserver(1)>,
 120 L<fs_getclientaddrs(1)>
 121
 122 =cut