# VBoxManage guestproperty

VBoxManage-guestproperty

1

VBoxManage-guestproperty

управляет гостевыми свойствами виртуальной машины

&product-name;

          VBoxManage guestproperty get

            uuid
            имя-ВМ

          имя-свойства
          --verbose

          VBoxManage guestproperty enumerate

            uuid
            имя-ВМ

          --patterns=шаблоны

          VBoxManage guestproperty set

            uuid
            имя-ВМ

          имя-свойства
          значение-свойства--flags=флаги

          VBoxManage guestproperty unset

            uuid
            имя-ВМ

          имя-свойства

          VBoxManage guestproperty wait

            uuid
            имя-ВМ

          шаблоны
          --timeout=миллисекунды
          --fail-on-timeout

## Описание

Команда `VBoxManage guestproperty` позволяет установить или получить свойства работающей виртуальной машины (ВМ). Смотрите guestadd-guestprops. Гостевые свойства - это произвольные пары строк в виде имя-значение, которые могут быть записаны и прочтены как с гостевой системы так и с хоста. В результате эти свойства могут быть использованы как канал связи небольшого объема для строк при условии, что гость работает и установлены Дополнения Гостевой ОС. Также, Дополнения Гостевой ОС автоматически устанавливают и поддерживают значения ключей, начинающихся с `/VirtualBox/`.

### Общие командные операнды

`uuid`|`имя-ВМ`

- Задает Универсальный Уникальный Идентификатор (UUID) или имя ВМ.

### Показать все свойства виртуальной машины

Команда `VBoxManage guestproperty enumerate` показывает каждое гостевое свойство и его значение для указанной ВМ. Заметим, что вывод ограничен если невозможно подсоединиться к процессу гостевой службы, например потому что ВМ не работает или не установлены Дополнения Гостевой ОС.

`--patterns=`шаблон``

- Фильтрует список свойств основанный на указанном шаблоне, который может содержать следующие подстановочные знаки:

  `*` (звездочка)

- Представляет любое количество произвольных символов. Например, шаблон `/VirtualBox*` соответствует всем свойствам, начинающимся с `/VirtualBox`.

`?` (знак вопроса)

- Представляет один произвольный символ. Например шаблон `fo?` соответствует и `foo` и `for`.

`|` (канал)

- Задает несколько альтернативных шаблонов. Например шаблон `s*|t*` соответствует свойствам, начинающимся с `s` или `t`.

### Получить значение свойства виртуальной машины

Команда `VBoxManage guestproperty get` получает значение указанного свойства. Если свойство не найдено, например, потому что гостевая система сейчас не работает, команда выдает следующее сообщение:

    No value set!

`имя-свойства`

- Задает имя свойства.

`--verbose`

- Выдает значение свойства, метку времени и любые указанные аттрибуты значения.

### Задать значение свойства для виртуальной машины

Команда `VBoxManage guestproperty set` позволяет задать свойство гостевой системы, указывая свойство и его значение. Если значение опущено, свойство удаляется.

`имя-свойства`

- Задает имя свойства.

`значение-свойства`

- Указывает значение свойства. Если значение не указано, существующее значение удаляется.

`--flags=`флаги``

- Задает дополнительные аттрибуты значения. Могут быть указаны следующие аттрибуты в виде списка значений разделенных запятыми:

  `TRANSIENT`

- Удаляет значение с данными ВМ при завершении ВМ.

`TRANSRESET`

- Удаляет значение при завершении или рестарте ВМ.

`RDONLYGUEST`

- Задает значение, которое может быть изменено только хостом. Гостевая система может только прочитать значение свойства.

`RDONLYHOST`

- Задает значение, которое может быть изменено только гостевой системой. Хост может только прочитать значение свойства.

`READONLY`

- Задает неизменяемое значение.

### Ожидать создания, удаления или изменения значения свойства

Команда `VBoxManage guestproperty wait` ожидает создания, удаления или изменения определенного свойства, описанного строкой шаблона.

`шаблоны`

- Задает шаблон, соответствующий свойствам, необходимым для ожидания. По информации о подстановочных знаках в шаблоне смотрите описание опции `--patterns`.

`--timeout`миллисекунды``

- Задает количество миллисекунд ожидания.

`--fail-on-timeout`

- Указывает, что команда должна закончиться неудачей если достигнут порог ожидания.

### Удалить значение свойства виртуальной машины

Команда `VBoxManage guestproperty unset` удаляет значение гостевого свойства.

Альтернативная формат этой подкоманды `delete`.

`имя-свойства`

- Задает имя свойства.

## Примеры

Следующая команда выдает список гостевых свойств и их значений для ВМ `win8`.

    $ VBoxManage guestproperty enumerate win8

Следующая команда создает гостевое свойство называемое `region` для ВМ `win8`. Значение свойства устанавливается в `west`.

    $ VBoxManage guestproperty set win8 region west