VirtualBox

source: vbox/trunk/doc/manual/ru_RU/man_VBoxManage-guestproperty.xml@ 103131

Last change on this file since 103131 was 98103, checked in by vboxsync, 23 months ago

Copyright year updates by scm.

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

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette