| 1 | <?xml version="1.0" encoding="UTF-8"?>
|
|---|
| 2 | <!--
|
|---|
| 3 | manpage, user manual, usage: VBoxManage guestproperty
|
|---|
| 4 |
|
|---|
| 5 | Copyright (C) 2006-2020 Oracle Corporation
|
|---|
| 6 |
|
|---|
| 7 | This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 8 | available from http://www.virtualbox.org. This file is free software;
|
|---|
| 9 | you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 10 | General Public License (GPL) as published by the Free Software
|
|---|
| 11 | Foundation, in version 2 as it comes in the "COPYING" file of the
|
|---|
| 12 | VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
|---|
| 13 | hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 14 | -->
|
|---|
| 15 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
|---|
| 16 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"[
|
|---|
| 17 | <!ENTITY % all.entities SYSTEM "all-entities.ent">
|
|---|
| 18 | %all.entities;
|
|---|
| 19 | ]>
|
|---|
| 20 | <refentry id="vboxmanage-guestproperty" lang="en">
|
|---|
| 21 | <refentryinfo>
|
|---|
| 22 | <pubdate>$Date: 2022-03-14 09:39:06 +0000 (Mon, 14 Mar 2022) $</pubdate>
|
|---|
| 23 | <title>VBoxManage guestproperty</title>
|
|---|
| 24 | </refentryinfo>
|
|---|
| 25 |
|
|---|
| 26 | <refmeta>
|
|---|
| 27 | <refentrytitle>VBoxManage-guestproperty</refentrytitle>
|
|---|
| 28 | <manvolnum>1</manvolnum>
|
|---|
| 29 | </refmeta>
|
|---|
| 30 |
|
|---|
| 31 | <refnamediv>
|
|---|
| 32 | <refname>VBoxManage-guestproperty</refname>
|
|---|
| 33 | <refpurpose>управляет гостевыми свойствами виртуальной машины</refpurpose>
|
|---|
| 34 | <refclass>&product-name;</refclass>
|
|---|
| 35 | </refnamediv>
|
|---|
| 36 |
|
|---|
| 37 | <refsynopsisdiv>
|
|---|
| 38 | <!-- The 'id' is mandatory and must start with 'synopsis-'. -->
|
|---|
| 39 | <cmdsynopsis id="synopsis-vboxmanage-guestproperty-get">
|
|---|
| 40 | <command>VBoxManage guestproperty get</command>
|
|---|
| 41 | <group choice="req">
|
|---|
| 42 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 43 | <arg choice="plain"><replaceable>имя-ВМ</replaceable></arg>
|
|---|
| 44 | </group>
|
|---|
| 45 | <arg choice="req"><replaceable>имя-свойства</replaceable></arg>
|
|---|
| 46 | <arg>--verbose</arg>
|
|---|
| 47 | </cmdsynopsis>
|
|---|
| 48 |
|
|---|
| 49 | <cmdsynopsis id="synopsis-vboxmanage-guestproperty-enumerate">
|
|---|
| 50 | <command>VBoxManage guestproperty enumerate</command>
|
|---|
| 51 | <group choice="req">
|
|---|
| 52 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 53 | <arg choice="plain"><replaceable>имя-ВМ</replaceable></arg>
|
|---|
| 54 | </group>
|
|---|
| 55 | <arg>--patterns=<replaceable>шаблоны</replaceable></arg>
|
|---|
| 56 | </cmdsynopsis>
|
|---|
| 57 |
|
|---|
| 58 | <cmdsynopsis id="synopsis-vboxmanage-guestproperty-set">
|
|---|
| 59 | <command>VBoxManage guestproperty set</command>
|
|---|
| 60 | <group choice="req">
|
|---|
| 61 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 62 | <arg choice="plain"><replaceable>имя-ВМ</replaceable></arg>
|
|---|
| 63 | </group>
|
|---|
| 64 | <arg choice="req"><replaceable>имя-свойства</replaceable></arg>
|
|---|
| 65 | <arg><replaceable>значение-свойства</replaceable><arg>--flags=<replaceable>флаги</replaceable></arg></arg>
|
|---|
| 66 | </cmdsynopsis>
|
|---|
| 67 |
|
|---|
| 68 | <cmdsynopsis id="synopsis-vboxmanage-guestproperty-unset">
|
|---|
| 69 | <command>VBoxManage guestproperty unset</command>
|
|---|
| 70 | <group choice="req">
|
|---|
| 71 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 72 | <arg choice="plain"><replaceable>имя-ВМ</replaceable></arg>
|
|---|
| 73 | </group>
|
|---|
| 74 | <arg choice="req"><replaceable>имя-свойства</replaceable></arg>
|
|---|
| 75 | </cmdsynopsis>
|
|---|
| 76 |
|
|---|
| 77 | <cmdsynopsis id="synopsis-vboxmanage-guestproperty-wait">
|
|---|
| 78 | <command>VBoxManage guestproperty wait</command>
|
|---|
| 79 | <group choice="req">
|
|---|
| 80 | <arg choice="plain"><replaceable>uuid</replaceable></arg>
|
|---|
| 81 | <arg choice="plain"><replaceable>имя-ВМ</replaceable></arg>
|
|---|
| 82 | </group>
|
|---|
| 83 | <arg choice="req"><replaceable>шаблоны</replaceable></arg>
|
|---|
| 84 | <arg>--timeout=<replaceable>миллисекунды</replaceable></arg>
|
|---|
| 85 | <arg>--fail-on-timeout</arg>
|
|---|
| 86 | </cmdsynopsis>
|
|---|
| 87 | </refsynopsisdiv>
|
|---|
| 88 |
|
|---|
| 89 | <refsect1>
|
|---|
| 90 | <title>Описание</title>
|
|---|
| 91 | <para>
|
|---|
| 92 | Команда <command>VBoxManage guestproperty</command> позволяет
|
|---|
| 93 | установить или получить свойства работающей виртуальной машины (ВМ).
|
|---|
| 94 | Смотрите <xref linkend="guestadd-guestprops" />. Гостевые свойства -
|
|---|
| 95 | это произвольные пары строк в виде имя-значение, которые могут
|
|---|
| 96 | быть записаны и прочтены как с гостевой системы так и с хоста.
|
|---|
| 97 | В результате эти свойства могут быть использованы как канал
|
|---|
| 98 | связи небольшого объема для строк при условии, что гость работает
|
|---|
| 99 | и установлены Дополнения Гостевой ОС. Также, Дополнения
|
|---|
| 100 | Гостевой ОС автоматически устанавливают и поддерживают значения
|
|---|
| 101 | ключей, начинающихся с <literal>/VirtualBox/</literal>.
|
|---|
| 102 | </para>
|
|---|
| 103 | <refsect2>
|
|---|
| 104 | <title>Общие командные операнды</title>
|
|---|
| 105 | <variablelist>
|
|---|
| 106 | <varlistentry>
|
|---|
| 107 | <term><replaceable>uuid</replaceable>|<replaceable>имя-ВМ</replaceable></term>
|
|---|
| 108 | <listitem><para>
|
|---|
| 109 | Задает Универсальный Уникальный Идентификатор (UUID) или
|
|---|
| 110 | имя ВМ.
|
|---|
| 111 | </para></listitem>
|
|---|
| 112 | </varlistentry>
|
|---|
| 113 | </variablelist>
|
|---|
| 114 | </refsect2>
|
|---|
| 115 | <refsect2 id="vboxmanage-guestproperty-enumerate">
|
|---|
| 116 | <title>Показать все свойства виртуальной машины</title>
|
|---|
| 117 | <para>
|
|---|
| 118 | Команда <command>VBoxManage guestproperty enumerate</command>
|
|---|
| 119 | показывает каждое гостевое свойство и его значение для
|
|---|
| 120 | указанной ВМ. Заметим, что вывод ограничен если невозможно
|
|---|
| 121 | подсоединиться к процессу гостевой службы, например потому
|
|---|
| 122 | что ВМ не работает или не установлены Дополнения Гостевой ОС.
|
|---|
| 123 | </para>
|
|---|
| 124 | <variablelist>
|
|---|
| 125 | <varlistentry>
|
|---|
| 126 | <term><option>--patterns=<replaceable>шаблон</replaceable></option></term>
|
|---|
| 127 | <listitem><para>
|
|---|
| 128 | Фильтрует список свойств основанный на указанном
|
|---|
| 129 | шаблоне, который может содержать следующие
|
|---|
| 130 | подстановочные знаки:
|
|---|
| 131 | </para><variablelist>
|
|---|
| 132 | <varlistentry>
|
|---|
| 133 | <term><literal>*</literal> (звездочка)</term>
|
|---|
| 134 | <listitem><para>
|
|---|
| 135 | Представляет любое количество произвольных символов.
|
|---|
| 136 | Например, шаблон <literal>/VirtualBox*</literal>
|
|---|
| 137 | соответствует всем свойствам, начинающимся с
|
|---|
| 138 | <literal>/VirtualBox</literal>.
|
|---|
| 139 | </para></listitem>
|
|---|
| 140 | </varlistentry>
|
|---|
| 141 | <varlistentry>
|
|---|
| 142 | <term><literal>?</literal> (знак вопроса)</term>
|
|---|
| 143 | <listitem><para>
|
|---|
| 144 | Представляет один произвольный символ. Например
|
|---|
| 145 | шаблон <literal>fo?</literal> соответствует и
|
|---|
| 146 | <literal>foo</literal> и <literal>for</literal>.
|
|---|
| 147 | </para></listitem>
|
|---|
| 148 | </varlistentry>
|
|---|
| 149 | <varlistentry>
|
|---|
| 150 | <term><literal>|</literal> (канал)</term>
|
|---|
| 151 | <listitem><para>
|
|---|
| 152 | Задает несколько альтернативных шаблонов.
|
|---|
| 153 | Например шаблон <literal>s*|t*</literal>
|
|---|
| 154 | соответствует свойствам, начинающимся с
|
|---|
| 155 | <literal>s</literal> или <literal>t</literal>.
|
|---|
| 156 | </para></listitem>
|
|---|
| 157 | </varlistentry>
|
|---|
| 158 | </variablelist></listitem>
|
|---|
| 159 | </varlistentry>
|
|---|
| 160 | </variablelist>
|
|---|
| 161 | </refsect2>
|
|---|
| 162 | <refsect2 id="vboxmanage-guestproperty-get">
|
|---|
| 163 | <title>Получить значение свойства виртуальной машины</title>
|
|---|
| 164 | <remark role="help-copy-synopsis"/>
|
|---|
| 165 | <para>
|
|---|
| 166 | Команда <command>VBoxManage guestproperty get</command>
|
|---|
| 167 | получает значение указанного свойства. Если свойство не
|
|---|
| 168 | найдено, например, потому что гостевая система сейчас не
|
|---|
| 169 | работает, команда выдает следующее сообщение:
|
|---|
| 170 | </para>
|
|---|
| 171 | <screen>No value set!</screen>
|
|---|
| 172 | <variablelist>
|
|---|
| 173 | <varlistentry>
|
|---|
| 174 | <term><replaceable>имя-свойства</replaceable></term>
|
|---|
| 175 | <listitem><para>
|
|---|
| 176 | Задает имя свойства.
|
|---|
| 177 | </para></listitem>
|
|---|
| 178 | </varlistentry>
|
|---|
| 179 | <varlistentry>
|
|---|
| 180 | <term><option>--verbose</option></term>
|
|---|
| 181 | <listitem><para>
|
|---|
| 182 | Выдает значение свойства, метку времени и любые указанные
|
|---|
| 183 | аттрибуты значения.
|
|---|
| 184 | </para></listitem>
|
|---|
| 185 | </varlistentry>
|
|---|
| 186 | </variablelist>
|
|---|
| 187 | </refsect2>
|
|---|
| 188 | <refsect2 id="vboxmanage-guestproperty-set">
|
|---|
| 189 | <title>Задать значение свойства для виртуальной машины</title>
|
|---|
| 190 | <remark role="help-copy-synopsis"/>
|
|---|
| 191 | <para>
|
|---|
| 192 | Команда <command>VBoxManage guestproperty set</command> позволяет
|
|---|
| 193 | задать свойство гостевой системы, указывая свойство и его значение.
|
|---|
| 194 | Если значение опущено, свойство удаляется.
|
|---|
| 195 | </para>
|
|---|
| 196 | <variablelist>
|
|---|
| 197 | <varlistentry>
|
|---|
| 198 | <term><replaceable>имя-свойства</replaceable></term>
|
|---|
| 199 | <listitem><para>
|
|---|
| 200 | Задает имя свойства.
|
|---|
| 201 | </para></listitem>
|
|---|
| 202 | </varlistentry>
|
|---|
| 203 | <varlistentry>
|
|---|
| 204 | <term><replaceable>значение-свойства</replaceable></term>
|
|---|
| 205 | <listitem><para>
|
|---|
| 206 | Указывает значение свойства. Если значение не указано,
|
|---|
| 207 | существующее значение удаляется.
|
|---|
| 208 | </para></listitem>
|
|---|
| 209 | </varlistentry>
|
|---|
| 210 | <varlistentry>
|
|---|
| 211 | <term><option>--flags=<replaceable>флаги</replaceable></option></term>
|
|---|
| 212 | <listitem><para>
|
|---|
| 213 | Задает дополнительные аттрибуты значения. Могут быть указаны
|
|---|
| 214 | следующие аттрибуты в виде списка значений разделенных запятыми:
|
|---|
| 215 | </para><variablelist>
|
|---|
| 216 | <varlistentry>
|
|---|
| 217 | <term><literal>TRANSIENT</literal></term>
|
|---|
| 218 | <listitem><para>
|
|---|
| 219 | Удаляет значение с данными ВМ при завершении ВМ.
|
|---|
| 220 | </para></listitem>
|
|---|
| 221 | </varlistentry>
|
|---|
| 222 | <varlistentry>
|
|---|
| 223 | <term><literal>TRANSRESET</literal></term>
|
|---|
| 224 | <listitem><para>
|
|---|
| 225 | Удаляет значение при завершении или рестарте ВМ.
|
|---|
| 226 | </para></listitem>
|
|---|
| 227 | </varlistentry>
|
|---|
| 228 | <varlistentry>
|
|---|
| 229 | <term><literal>RDONLYGUEST</literal></term>
|
|---|
| 230 | <listitem><para>
|
|---|
| 231 | Задает значение, которое может быть изменено только
|
|---|
| 232 | хостом. Гостевая система может только прочитать
|
|---|
| 233 | значение свойства.
|
|---|
| 234 | </para></listitem>
|
|---|
| 235 | </varlistentry>
|
|---|
| 236 | <varlistentry>
|
|---|
| 237 | <term><literal>RDONLYHOST</literal></term>
|
|---|
| 238 | <listitem><para>
|
|---|
| 239 | Задает значение, которое может быть изменено только
|
|---|
| 240 | гостевой системой. Хост может только прочитать
|
|---|
| 241 | значение свойства.
|
|---|
| 242 | </para></listitem>
|
|---|
| 243 | </varlistentry>
|
|---|
| 244 | <varlistentry>
|
|---|
| 245 | <term><literal>READONLY</literal></term>
|
|---|
| 246 | <listitem><para>
|
|---|
| 247 | Задает неизменяемое значение.
|
|---|
| 248 | </para></listitem>
|
|---|
| 249 | </varlistentry>
|
|---|
| 250 | </variablelist></listitem>
|
|---|
| 251 | </varlistentry>
|
|---|
| 252 | </variablelist>
|
|---|
| 253 | </refsect2>
|
|---|
| 254 | <refsect2 id="vboxmanage-guestproperty-wait">
|
|---|
| 255 | <title>Ожидать создания, удаления или изменения значения свойства</title>
|
|---|
| 256 | <remark role="help-copy-synopsis"/>
|
|---|
| 257 | <para>
|
|---|
| 258 | Команда <command>VBoxManage guestproperty wait</command> ожидает
|
|---|
| 259 | создания, удаления или изменения определенного свойства,
|
|---|
| 260 | описанного строкой шаблона.
|
|---|
| 261 | </para>
|
|---|
| 262 | <variablelist>
|
|---|
| 263 | <varlistentry>
|
|---|
| 264 | <term><replaceable>шаблоны</replaceable></term>
|
|---|
| 265 | <listitem><para>
|
|---|
| 266 | Задает шаблон, соответствующий свойствам, необходимым
|
|---|
| 267 | для ожидания. По информации о подстановочных знаках
|
|---|
| 268 | в шаблоне смотрите описание опции
|
|---|
| 269 | <option>--patterns</option>.
|
|---|
| 270 | </para></listitem>
|
|---|
| 271 | </varlistentry>
|
|---|
| 272 | <varlistentry>
|
|---|
| 273 | <term><option>--timeout<replaceable>миллисекунды</replaceable></option></term>
|
|---|
| 274 | <listitem><para>
|
|---|
| 275 | Задает количество миллисекунд ожидания.
|
|---|
| 276 | </para></listitem>
|
|---|
| 277 | </varlistentry>
|
|---|
| 278 | <varlistentry>
|
|---|
| 279 | <term><option>--fail-on-timeout</option></term>
|
|---|
| 280 | <listitem><para>
|
|---|
| 281 | Указывает, что команда должна закончиться неудачей
|
|---|
| 282 | если достигнут порог ожидания.
|
|---|
| 283 | </para></listitem>
|
|---|
| 284 | </varlistentry>
|
|---|
| 285 | </variablelist>
|
|---|
| 286 | </refsect2>
|
|---|
| 287 | <refsect2 id="vboxmanage-guestproperty-unset">
|
|---|
| 288 | <title>Удалить значение свойства виртуальной машины</title>
|
|---|
| 289 | <remark role="help-copy-synopsis"/>
|
|---|
| 290 | <para>
|
|---|
| 291 | Команда <command>VBoxManage guestproperty unset</command>
|
|---|
| 292 | удаляет значение гостевого свойства.
|
|---|
| 293 | </para>
|
|---|
| 294 | <para>
|
|---|
| 295 | Альтернативная формат этой подкоманды <command>delete</command>.
|
|---|
| 296 | </para>
|
|---|
| 297 | <variablelist>
|
|---|
| 298 | <varlistentry>
|
|---|
| 299 | <term><replaceable>имя-свойства</replaceable></term>
|
|---|
| 300 | <listitem><para>
|
|---|
| 301 | Задает имя свойства.
|
|---|
| 302 | </para></listitem>
|
|---|
| 303 | </varlistentry>
|
|---|
| 304 | </variablelist>
|
|---|
| 305 | </refsect2>
|
|---|
| 306 | </refsect1>
|
|---|
| 307 |
|
|---|
| 308 | <refsect1>
|
|---|
| 309 | <title>Примеры</title>
|
|---|
| 310 | <remark role="help-scope" condition="GLOBAL" />
|
|---|
| 311 | <para>
|
|---|
| 312 | Следующая команда выдает список гостевых свойств и их значений
|
|---|
| 313 | для ВМ <literal>win8</literal>.
|
|---|
| 314 | </para>
|
|---|
| 315 | <screen>$ VBoxManage guestproperty enumerate win8</screen>
|
|---|
| 316 | <para>
|
|---|
| 317 | Следующая команда создает гостевое свойство называемое
|
|---|
| 318 | <literal>region</literal> для ВМ <literal>win8</literal>.
|
|---|
| 319 | Значение свойства устанавливается в <literal>west</literal>.
|
|---|
| 320 | </para>
|
|---|
| 321 | <screen>$ VBoxManage guestproperty set win8 region west</screen>
|
|---|
| 322 | </refsect1>
|
|---|
| 323 | </refentry>
|
|---|
