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