NAME

bos_getfile - Fetches a file by path from the bosserver

SYNOPSIS

bos getfile -server <machine name> -file <file to fetch> -output <local output file>] [-cell <cell name>] [-noauth] [-localauth] [-principal <authentication principal> [-verbose] [-encrypt [<yes|no>]] [-config <configuration file>] [-help]

DESCRIPTION

The bos getfile command fetches the file specified by -file from the machine named by the -server argument, and either displays it on the standard output stream, or stores it to the path specified by the -output argument.

OPTIONS

-server <machine name>

Indicates the server machine from which to retrieve a file. Identify the machine by IP address or its host name (either fully-qualified or abbreviated unambiguously). For details, see bos(8).

-file <file to fetch>

Names the file to fetch.

-output <local output file>

Specifies a local path where the fetched file will be stored.

The default when no path is specified is to display the file to standard output.

-verbose

Specifies that the command should provide verbose output.

-cell <cell name>

Names the cell in which to run the command. Do not combine this argument with the -localauth flag. For more details, see bos(8).

-noauth

Assigns the unprivileged identity anonymous to the issuer. Do not combine this flag with the -localauth flag. For more details, see bos(8).

-localauth

Constructs a server ticket using a key from the local /etc/yfs/server/KeyFileExt file. The bos command interpreter presents the ticket to the BOS Server during mutual authentication. Do not combine this flag with the -cell or -noauth options. For more details, see bos(8).

-principal <authentication principal>

Indicates the principal to be used for authentication. This option can be useful when several credentials caches are available for different principals.

-encrypt [<yes|no>]

Enables or disables encryption for the command so that the operation's results are not transmitted across the network in clear text.

-verbose

Produces on the standard output stream a detailed trace of the command's execution. If this argument is omitted, only warnings and error messages appear.

-config <configuration file>

Sets the location of the configuration file to be used. The default file is /etc/yfs/yfs-client.conf.

-help

Prints the online help for this command. All other valid options are ignored.

OUTPUT

If the command was run with -verbose, the output is preceded by the line

   Fetching file '<filename>'...

The remainder of the output depends on the particular file, if run without -path.

EXAMPLES

The following example displays the BosLog file from the machine fs3.example.com:

   % bos getfile -verbose -server fs3.example.com -path /var/log/yfs/BosLog
   Fetching file 'BosLog'...
   Tue Oct 27 17:01:58 2020: Using config path /etc/yfs/server/yfs-server.conf
   Tue Oct 27 17:01:58 2020: Starting AuriStor bosserver ...
   ...

PRIVILEGE REQUIRED

The issuer must be listed in the /etc/yfs/server/UserListExt or /etc/yfs/server/ReaderList files on the machine named by the -server argument, or must be logged onto a server with an account capable of reading the /etc/yfs/server/KeyFileExt file if the -localauth flag is included.

NOTES

bos_getlog(8) and bos_getfile(8) are similar but tailored for different purposes. bos_getlog(8) is appropriate when fetching a text log file that might be extended while the operation is in progress. bos_getlog(8) should not be used to transfer files that include embedded NUL(0) characters, as they will be stripped from the file stream during transfer.

bos_getfile(8) can be used to get any text or binary file. bos_getfile(8) will transfer the contents of the specified file without alteration. If the file is truncated on the server during the transfer, the bos_getfile(8) command will fail. If the file is extended during the transfer, only the contents up to the size of the file at the start of the operation will be received.

SEE ALSO

bos(8), bos_getlog(8)

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.

ACKNOWLEDGEMENTS

"AFS" is a registered mark of International Business Machines Corporation, used under license. (USPTO Registration 1598389)

"OpenAFS" is a registered mark of International Business Machines Corporation. (USPTO Registration 4577045)

The "AuriStor" name, log 'S' brand mark, and icon are registered marks of AuriStor, Inc. (USPTO Registrations 4849419, 4849421, and 4928460) (EUIPO Registration 015539653).

"Your File System" is a registered mark of AuriStor, Inc. (USPTO Registrations 4801402 and 4849418).

"YFS" and "AuriStor File System" are trademarks of AuriStor, Inc.