NAME

vos_offline - Sets a volume's state to offline

SYNOPSIS

vos offline -server <machine name> -partition <partition name> -id <volume name or ID> [-sleep <seconds to sleep>] [-busy] [-cell <cell name>] [-noauth] [-auth] [-localauth] [-encrypt [<yes|no>]] [-verbose] [-noresolve] [-config <configuration file>] [-help]

DESCRIPTION

The vos offline command sets the state of the volume specified by the -id argument, housed on the site specified by the -server and -partition arguments, to offline.

A volume that is in the offline state cannot be accessed by Cache Managers.

CAUTIONS

The vos offline command will place the specified volume into the offline state regardless of whether or not it is being actively accessed by Cache Managers. Access to the data stored in the volume will be immediately impacted.

OPTIONS

-server <machine name>

Identifies the File Server where the volume resides. Provide a fully qualified host name or an IP address. Provide a fully qualified host name, an IP address or UUID as reported by vos listfs.

-partition <partition name>

Identifies the partition where the volume resides, on the file server machine named by the -server argument. Provide the partition's complete name with preceding slash (for example, /vicepa) or use one of the three acceptable abbreviated forms. For details, see vos(1).

-id <volume name or ID>

Specifies either the complete name or volume ID number of the volume.

-sleep <seconds to sleep>

Specifies to sleep for a certain number of seconds after taking the volume offline before bringing it online again. If this option is specified, the volume will be online when vos offline successfully completes. If this option is not specified, vos online must be run to bring the volume online.

-busy

Specifies to mark the volume as `busy' instead of `offline'. This means that a program trying to access this volume will receive a VBUSY error instead of a VOFFLINE error (until the volume is brought back online).

Different programs may react differently when they see these two different states, but in general a `busy' volume is only unavailable for a short period of time and will become online soon. An `offline' volume, on the other hand, is typically unavailable for longer periods and may not come back online until an administrator intervenes.

As an example of when these states occur normally, a volume can be busy when it is being cloned (perhaps as the result of a vos backup or vos release operation). A volume can be offline if a fileserver has detected a problem with the volume that cannot be automatically corrected.

If -busy is specified, the -sleep option must also be specified, to indicate for how long to keep the volume busy.

-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 vos.

-noauth

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

-localauth

Obtains an authentication token using the server encryption key with the highest key version number in the local /etc/yfs/server/KeyFileExt file. The resulting token never expires and has Super User privileges. Do not combine this flag with the -cell argument or -noauth flag. For more details, see vos.

-auth

Use the calling user's tokens from the kernel or as obtained using the active Kerberos ticket granting ticket to communicate with the Volume Server and Location Service. This is the default if neither -localauth nor -noauth is given.

Since this option is the default, it is usually not useful for running single command line operations. However, it can be useful when running commands via vos interactive or vos source, since otherwise it would be impossible to switch from, for example, -localauth back to using regular tokens during a bulk operation.

-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.

-encrypt [<yes|no>]

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

-noresolve

Shows all servers as IP addresses instead of the reverse DNS lookup hostname. -noresolve useful when troubleshooting no such volume and volume moved errors.

-config <configuration file>

Set 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.

EXAMPLES

The following example takes an online volume offline:

   % vos offline -server sv7.your-cell-name.com -partition /vicepb -id root.afs

PRIVILEGE REQUIRED

The issuer must be listed in the /etc/yfs/server/UserListExt file on the File Server specified by the -server argument and on each Location Server. If the -localauth flag is included, the issuer must instead be logged on to a server with an account capable of reading the /etc/yfs/server/KeyFileExt file.

SEE ALSO

vos(1), vos_listfs(1), vos_online(1), bos_salvage(8),

COPYRIGHT

IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.

This man page was created by Steven Jenkins.

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.