Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
volutil(8)		    System Manager's Manual		    volutil(8)

NAME
       volutil - volume	utility	subsystem

SYNOPSIS
       volutil [-h <server>] [ -t timeout] [ -d	debuglevel] <command> <parame-
       ters ...	>

DESCRIPTION
       Volutil is a RPC	interface to the volume	utility	subsystem of  the file
       server.	 The volume utilities are used to perform administrative func-
       tions like creating, cloning, purging, dumping and  restoring  volumes.
       Each  of	 these	functions  can be invoked via the <command> parameter.
       Each command has	a set of parameters that it expects.  These are	listed
       below  along  with  a  short  description of each command.  The volutil
       utility may be instructed to perform the	operations on a	 server	 at  a
       remote  site  by	 specifying the	server to which	to connect with	the -h
       option.	The default is to connect to a server on  the  local  machine.
       The  -t	option	may  be	used to	specify	the timeout (in	seconds) to be
       used by RPC2.

       ancient _group-ID_ _rep-ID_
	      Tell the server that backup succeeded for	this volume. The  next
	      dump  of this volume, if incremental, will be based on the state
	      represented by this backup.  The input should be in Hex.

       backup _volume-ID_
	      Create a backup clone of a read/write volume.  If	a backup clone
	      already  exists,	update	it to reflect the current state	of the
	      read/write volume; Otherwise, create  a  new  read-only  volume.
	      The  read/write  volume  must  be	 locked	 for  this to succeed.
	      Backup unlocks the volume	as a side effect.

       clone volume-ID [-n new-volume-name]
	      Create a read only clone of a read write volume  with  (replica)
	      ID (_volume-ID_).	 The vnodes are	actually copied	but the	inodes
	      are marked copy-on-write i.e. inodes need	to be copied  only  if
	      modified.	  The  name of the new cloned volume can be optionally
	      specified	by the _new-volume-name_ parameter.  Default value  is
	      volume-name.readonly.   The clone(8) command can be used to call
	      volutil clone.

       create _partition-path_ _volume-name_
	      Create a nonreplicated read-write	volume named _volume-name_  on
	      partition	named _partition-path_.	 The createvol(8) command is a
	      simplified front-end for this option.

       create_rep _partition-path_
	      _volume-name_ _group-ID_"	Create a replicated read-write	volume
	      named  _volume-name_  on	partition named	_partition-path_.  The
	      _group-ID_ parameter is used to specify the ID of	the replicated
	      volume  to which this replica will belong.  The createvol_rep(8)
	      command will also	create a replicated volume.

       dump [-i] _volume-ID_
	      _file-name_" Dump	the entire contents of a volume	(volume-ID  in
	      Hex)  to	a file	(file-name).  If the -i	flag is	used, the dump
	      will be incremental, it will only	include	vnodes which have been
	      modified since the last dump was taken.  The dump	is not machine
	      independent, certain fields in the Vnode are not	translated  to
	      network  order.	However,  dump files can be used to create re-
	      stored volumes on	machines with a	similar	byte-order.

       dumpmem _file-name_ _address_ _size_
	      Dump _size_ bytes	starting at _address_ into _file-name_.

       elapse _on | off_ _resolution | cb | mond | volDump_ [MultiRPC]
	      Turn on or off timers for	the given subsystem.

       info [-all] _volume-name	|
	      volume-number> _file-name_" Print	in ascii  the  contents	 of  a
	      volume into a file (_file-name_).	The volume can be specified by
	      its name,	or by the volume-ID, specified	in  Hex.  If  -all  is
	      specified,  contents of both large and small vnodes in that vol-
	      ume are also printed.

       lock _volume-ID_
	      Lock a volume to prevent write access to the  volume.  To	 other
	      users it will appear as if the operation would time out.

       lookup _volume-name | volume-ID_
	      _file-name_" Print information about a volume (specified by vol-
	      ume-name or volume-ID specified  in  Hex)	 in  file-name.	  Only
	      meta-information,	such as	replicated group-ID, location, etc. is
	      printed.

       makevldb	_VolumeList_
	      Create a new Volume Location Database VLDB.  VolumeList names  a
	      file containing volume parameters	for all	volumes	in the system.
	      This command typically is	run on	the  system  control  machine.
	      See also bldvldb(8) and volumelist(5).

       makevrdb	_vrlist_
	      Create a new Volume Replication Data Base	(VRDB).	 _vrlist_ is a
	      file containing entries describing replicated volumes.  Each en-
	      try contains the name, group-ID, read-write ids, and the VSG ad-
	      dress of a replicated volume.  There is one entry	per replicated
	      volume in	the system.

       purge _volume-ID_ _volume-name_
	      Delete  a	 volume.   For replicated volumes purge	must be	called
	      from each	server individually on the replicas at	the  different
	      servers. (See purgevol-rep(8))

       restore _file-name_
	      _partition-path_	[_volume-name_	[_volume-ID_ ] ]" Create a new
	      volume on	the partition named by _partition-path_	 and  read  in
	      the  contents  from  a  dump in file _file-name_.	The new	volume
	      will be given the	name and ID specified on the command line.  If
	      either  is  unspecified, or if the Volume	ID is of illegal form,
	      the server will allocate the ID or name based on internal	rules.
	      The volume-ID should be specified	in Hex.

       rvmsize _volume-ID_
	      Print the	RVM statistics for the volume _volume-ID_.

       setdebug	_level_
	      Set  the	debug  level  for the volume and directory packages to
	      level.  To reset it use zero for the level argument.   The  rpc2
	      debug level is set to level/10.

       setlogparms _volume-ID_
	      [reson  <4  | 0>]	[logsize _size_]" Turn on resolution or	change
	      the log size for a volume.  The volume  ID  can  be  either  the
	      replicated ID or the non-replicated ID.  Resolution is turned on
	      by specifying 4 after reson and can be turned off	by  specifying
	      0.  The size of the log can also be changed for the volume.  The
	      size parameter refers to the number of maximum  entries  in  the
	      log.  This should	be a multiple of 32.  Typically	this is	set to
	      8192.

	      NOTE: You	should in all normal cases keep	the resolution	turned
	      on, and the argument for reson is	in that	case 4!

       setvv _volumeNumber_ _vnodeNumber_
	      _Uniquifier_  _version numbers (8)> _host	unique flags_" Set the
	      version vector for a vnode (with fid = _volumeNumber_._vnodeNum-
	      ber_._Uniquifier_).   The	new version vector is specified	by the
	      _version numbers_	and the	_host unique flags_ triple.

       showvnode _volumeNumber_
	      _vnodeNumber_ _Uniquifier_ _file-name_" Print the	contents of  a
	      vnode  (with  fid	 = _volumeNumber_._vnodeNumber_._Uniquifier_).
	      into _file-name_.

       shutdown
	      Bring all	volumes	offline	and bring down the server.

       swaplog
	      Save the fileserver log output (in SrvLog.old) and start	a  new
	      SrvLog.

       timing on | off _filename_
	      Turn timing on or	off.

       truncatervmlog
	      Forcibly truncate	the RVM	log.

       unlock _volume-ID_
	      Unlock a volume locked via the volutil lock command. (volume-ID)
	      should be	in Hex

       updatedb
	      Make the file server read	in a new VLDB and  VRDB.   The	server
	      assumes	the   databases	  to   exist   in   /vice/db/VLDB  and
	      /vice/db/VRDB.  This utility is useful for reading in new	 data-
	      bases at non-scm machines.

DIAGNOSTICS
       This command must be run	as root.  It works only	on the machine running
       the server. Also, the token file	/vice/db/voutil.tk must	be accessible.

BUGS
       The salvage option to volutil doesn't work right.  Please don't try it.

FILES
       /vice/db/VSGDB

       /vice/file/SrvLog

       /vice/db/VLDB

       /vice/db/VRDB

       /vice/vol/VRList

SEE ALSO
       vrdb(5),	 volumelist(5),	 bldvldb(8),  createvol(8),  createvol_rep(8),
       purgevol(8), purgevol_rep(8)

AUTHOR
       Puneet Kumar, David Steere, 1990, Created

								    volutil(8)

NAME | SYNOPSIS | DESCRIPTION | DIAGNOSTICS | BUGS | FILES | SEE ALSO | AUTHOR

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=volutil&sektion=8&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help