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