man/machinectl.html

   1 <html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>machinectl</title><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><style>
   2     a.headerlink {
   3       color: #c60f0f;
   4       font-size: 0.8em;
   5       padding: 0 4px 0 4px;
   6       text-decoration: none;
   7       visibility: hidden;
   8     }
   9
  10     a.headerlink:hover {
  11       background-color: #c60f0f;
  12       color: white;
  13     }
  14
  15     h1:hover > a.headerlink, h2:hover > a.headerlink, h3:hover > a.headerlink, dt:hover > a.headerlink {
  16       visibility: visible;
  17     }
  18   </style><a href="index.html">Index </a>·
  19   <a href="systemd.directives.html">Directives </a>·
  20   <a href="../python-systemd/index.html">Python </a>·
  21   <a href="../libudev/index.html">libudev </a>·
  22   <a href="../libudev/index.html">gudev </a><span style="float:right">systemd 208</span><hr><div class="refentry"><a name="machinectl"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>machinectl — Control the systemd machine manager</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">machinectl</code>  [OPTIONS...] {COMMAND} [NAME...]</p></div></div><div class="refsect1"><a name="idm274680855120"></a><h2 id="Description">Description<a class="headerlink" title="Permalink to this headline" href="#Description">¶</a></h2><p><span class="command"><strong>machinectl</strong></span> may be used to
  23                 introspect and control the state of the
  24                 <a href="systemd.html"><span class="citerefentry"><span class="refentrytitle">systemd</span>(1)</span></a>
  25                 virtual machine and container registration manager <a href="systemd-machined.service.html"><span class="citerefentry"><span class="refentrytitle">systemd-machined.service</span>(8)</span></a>.</p></div><div class="refsect1"><a name="idm274678658656"></a><h2 id="Options">Options<a class="headerlink" title="Permalink to this headline" href="#Options">¶</a></h2><p>The following options are understood:</p><div class="variablelist"><dl class="variablelist"><dt id="-h"><span class="term"><code class="option">-h</code>, </span><span class="term"><code class="option">--help</code></span><a class="headerlink" title="Permalink to this term" href="#-h">¶</a></dt><dd><p>Prints a short help
  26                                 text and exits.</p></dd><dt id="--version"><span class="term"><code class="option">--version</code></span><a class="headerlink" title="Permalink to this term" href="#--version">¶</a></dt><dd><p>Prints a short version
  27                                 string and exits.</p></dd><dt id="-p"><span class="term"><code class="option">-p</code>, </span><span class="term"><code class="option">--property=</code></span><a class="headerlink" title="Permalink to this term" href="#-p">¶</a></dt><dd><p>When showing
  28                                 machine properties, limit the
  29                                 output to certain properties as
  30                                 specified by the argument. If not
  31                                 specified, all set properties are
  32                                 shown. The argument should be a
  33                                 property name, such as
  34                                 "<code class="literal">Name</code>". If
  35                                 specified more than once, all
  36                                 properties with the specified names
  37                                 are shown.</p></dd><dt id="-a"><span class="term"><code class="option">-a</code>, </span><span class="term"><code class="option">--all</code></span><a class="headerlink" title="Permalink to this term" href="#-a">¶</a></dt><dd><p>When showing
  38                                 machine properties, show all
  39                                 properties regardless of whether they are
  40                                 set or not.</p></dd><dt id="-l"><span class="term"><code class="option">-l</code>, </span><span class="term"><code class="option">--full</code></span><a class="headerlink" title="Permalink to this term" href="#-l">¶</a></dt><dd><p>Do not ellipsize
  41                                 process tree entries.</p></dd><dt id="--no-pager"><span class="term"><code class="option">--no-pager</code></span><a class="headerlink" title="Permalink to this term" href="#--no-pager">¶</a></dt><dd><p>Do not pipe output into a
  42                                 pager.</p></dd><dt id="--no-ask-password"><span class="term"><code class="option">--no-ask-password</code></span><a class="headerlink" title="Permalink to this term" href="#--no-ask-password">¶</a></dt><dd><p>Do not query the user
  43                                 for authentication for privileged
  44                                 operations.</p></dd><dt id="--kill-who="><span class="term"><code class="option">--kill-who=</code></span><a class="headerlink" title="Permalink to this term" href="#--kill-who=">¶</a></dt><dd><p>When used with
  45                                 <span class="command"><strong>kill-machine</strong></span>,
  46                                 choose which processes to kill. Must
  47                                 be one of <code class="option">leader</code>, or
  48                                 <code class="option">all</code> to select whether
  49                                 to kill only the leader process of the
  50                                 machine or all processes of the
  51                                 machine. If omitted, defaults to
  52                                 <code class="option">all</code>.</p></dd><dt id="-s"><span class="term"><code class="option">-s</code>, </span><span class="term"><code class="option">--signal=</code></span><a class="headerlink" title="Permalink to this term" href="#-s">¶</a></dt><dd><p>When used with
  53                                 <span class="command"><strong>kill-machine</strong></span>, choose
  54                                 which signal to send to selected
  55                                 processes. Must be one of the
  56                                 well-known signal specifiers, such as
  57                                 <code class="constant">SIGTERM</code>,
  58                                 <code class="constant">SIGINT</code> or
  59                                 <code class="constant">SIGSTOP</code>. If
  60                                 omitted, defaults to
  61                                 <code class="constant">SIGTERM</code>.</p></dd><dt id="-H"><span class="term"><code class="option">-H</code>, </span><span class="term"><code class="option">--host</code></span><a class="headerlink" title="Permalink to this term" href="#-H">¶</a></dt><dd><p>Execute operation
  62                                 remotely. Specify a hostname, or
  63                                 username and hostname separated by "<code class="literal">@</code>",
  64                                 to connect to. This will use SSH to
  65                                 talk to the remote machine manager
  66                                 instance.</p></dd><dt id="-P"><span class="term"><code class="option">-P</code>, </span><span class="term"><code class="option">--privileged</code></span><a class="headerlink" title="Permalink to this term" href="#-P">¶</a></dt><dd><p>Acquire privileges via
  67                                 PolicyKit before executing the
  68                                 operation.</p></dd></dl></div><p>The following commands are understood:</p><div class="variablelist"><dl class="variablelist"><dt id="list"><span class="term"><span class="command"><strong>list</strong></span></span><a class="headerlink" title="Permalink to this term" href="#list">¶</a></dt><dd><p>List currently running
  69                                 virtual machines and containers.
  70                                 </p></dd><dt id="status [ID...]"><span class="term"><span class="command"><strong>status [ID...]</strong></span></span><a class="headerlink" title="Permalink to this term" href="#status%20%5BID...%5D">¶</a></dt><dd><p>Show terse runtime
  71                                 status information about one or more
  72                                 virtual machines and containers. This
  73                                 function is intended to generate
  74                                 human-readable output. If you are
  75                                 looking for computer-parsable output,
  76                                 use <span class="command"><strong>show</strong></span> instead.
  77                                 </p></dd><dt id="show [ID...]"><span class="term"><span class="command"><strong>show [ID...]</strong></span></span><a class="headerlink" title="Permalink to this term" href="#show%20%5BID...%5D">¶</a></dt><dd><p>Show properties of one
  78                                 or more registered virtual machines or
  79                                 containers or the manager itself. If
  80                                 no argument is specified, properties
  81                                 of the manager will be shown. If an
  82                                 ID is specified, properties of this
  83                                 virtual machine or container are
  84                                 shown. By default, empty properties
  85                                 are suppressed. Use
  86                                 <code class="option">--all</code> to show those
  87                                 too. To select specific properties to
  88                                 show, use
  89                                 <code class="option">--property=</code>. This
  90                                 command is intended to be used
  91                                 whenever computer-parsable output is
  92                                 required. Use
  93                                 <span class="command"><strong>status</strong></span> if you are
  94                                 looking for formatted human-readable
  95                                 output.</p></dd><dt id="terminate [ID...]"><span class="term"><span class="command"><strong>terminate [ID...]</strong></span></span><a class="headerlink" title="Permalink to this term" href="#terminate%20%5BID...%5D">¶</a></dt><dd><p>Terminates a virtual
  96                                 machine or container. This kills all
  97                                 processes of the virtual machine or
  98                                 container and deallocates all
  99                                 resources attached to that
 100                                 instance.</p></dd><dt id="kill [ID...]"><span class="term"><span class="command"><strong>kill [ID...]</strong></span></span><a class="headerlink" title="Permalink to this term" href="#kill%20%5BID...%5D">¶</a></dt><dd><p>Send a signal to one
 101                                 or more processes of the virtual
 102                                 machine or container. This means
 103                                 processes as seen by the host, not the
 104                                 processes inside the virtual machine
 105                                 or container.
 106                                 Use <code class="option">--kill-who=</code> to
 107                                 select which process to kill. Use
 108                                 <code class="option">--signal=</code> to select
 109                                 the signal to send.</p></dd></dl></div></div><div class="refsect1"><a name="idm274679440960"></a><h2 id="Exit status">Exit status<a class="headerlink" title="Permalink to this headline" href="#Exit%20status">¶</a></h2><p>On success, 0 is returned, a non-zero failure
 110                 code otherwise.</p></div><div class="refsect1"><a name="idm274680901760"></a><h2 id="Environment">Environment<a class="headerlink" title="Permalink to this headline" href="#Environment">¶</a></h2><div class="variablelist"><dl class="variablelist"><dt id="$SYSTEMD_PAGER"><span class="term"><code class="varname">$SYSTEMD_PAGER</code></span><a class="headerlink" title="Permalink to this term" href="#%24SYSTEMD_PAGER">¶</a></dt><dd><p>Pager to use when
 111                                 <code class="option">--no-pager</code> is not given;
 112                                 overrides <code class="varname">$PAGER</code>.  Setting
 113                                 this to an empty string or the value
 114                                 "<code class="literal">cat</code>" is equivalent to passing
 115                                 <code class="option">--no-pager</code>.</p></dd></dl></div></div><div class="refsect1"><a name="idm274680044672"></a><h2 id="See Also">See Also<a class="headerlink" title="Permalink to this headline" href="#See%20Also">¶</a></h2><p>
 116                         <a href="systemd-machined.service.html"><span class="citerefentry"><span class="refentrytitle">systemd-machined.service</span>(8)</span></a>,
 117                         <a href="systemd-logind.service.html"><span class="citerefentry"><span class="refentrytitle">systemd-logind.service</span>(8)</span></a>,
 118                         <a href="systemd.special.html"><span class="citerefentry"><span class="refentrytitle">systemd.special</span>(7)</span></a>.
 119                 </p></div></div></body></html>