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

FreeBSD Manual Pages

  
 
  

home | help
VMSTATEDCTL(1)		    General Commands Manual		VMSTATEDCTL(1)

NAME
       vmstatedctl -- Starts, stops and	manages	virtual	machines

SYNOPSIS
       vmstatedctl [-h]	[-s sockpath] command vmname

DESCRIPTION
       The  vmstatedctl	 utility  sends	user commands to vmstated(8) to	change
       the state and interoperate with virtual machines	running	on the host.

OPTIONS
       -s sockpath  specify sockpath to	be used	as path	to  vmstated's	socket
		    file instead of /var/run/vmstated.sock.

       -h	    print usage	summary	and exit immediately

   Supported commands
       vmstatedctl supports the	following commands for the command argument:

       start	   Starts a virtual machine

       stop	   Stops a virtual machine

       status	   Lists the known virtual machines managed by vmstated(8) and
		   their current runtime state

       failreset   Resets  a  virtual  machine,	 that has reached FAILED state
		   back	to the INIT state.

FILES
          /var/run/vmstated.sock - socket file	used by	vmstatedctl to	commu-
	   nicate with vmstated.

EXIT STATUS
       The vmstated utility exits 0 on success,	and >0 if an error occurs.  It
       may fail	for one	of the following reasons:

          It failed to	connect	to vmstated.
          It failed to	acquire	necessary resources.

SEE ALSO
       bhyve(8), vmstated(8)

HISTORY
       The vmstatedctl command first appeared in FreeBSD 13.2.

AUTHORS
       Christian Moerz <freebsd@ny-central.org>

FreeBSD	ports 15.0	       December	22, 2023		VMSTATEDCTL(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=vmstatedctl&sektion=1&manpath=FreeBSD+Ports+15.0>

home | help