# Приложение ## Статус объектов Перечень всех возможных статусов объектов VDI (параметр `state`). Не все объекты поддерживают все статусы. ``` 'A' - Active 'B' - Blocked 'C' - Canceled 'E' - Error 'F' - Finished 'H' - Balancing 'I' - Inactive 'J' - Too many preparing services 'K' - Canceling 'L' - Waiting publication 'M' - Removing 'P' - In preparation 'R' - Removable 'S' - Removed 'T' - Restrained 'U' - Valid 'W' - Running 'X' - Waiting execution 'Y' - In maintenance 'Z' - Waiting OS 'V' - Meta member ``` ## Параметры провайдеров и базовых сервисов ### PhysicalMachinesServiceProvider **Необязательные:** `config` - расширенная конфигурация, тип: *string* #### **IPMachinesService** `ipList` - список серверов, тип: *list of strings* `token` - токен сервиса, тип: *string* `port` - порт для проверки соединения, тип: *integer* `skipTimeOnFailure` - интервал между проверками соединения при неудаче, тип: *integer* `maxSessionForMachine` - максимальная продолжительность сеанса, в часах, тип: *integer* `lockByExternalAccess` - блокировать машину при внешнем доступе, тип: *boolean* `proxy_id` - id прокси, тип: *string*. Если отсутствует, используйте значение `-1`. ## Параметры аутентификаторов ### ActiveDirectoryAuthenticator `host` - IP или FQDN сервера AD, тип: *string* `username` - имя пользователя, тип: *string* `password` - пароль, тип: *string* `ldapBase` - база поиска, тип: *string* `ssl` - использовать SSL, тип: *string*. Допустимые значения: `true`, `false`. `timeout` - таймаут подключения, тип: *string* `groupBase` - база поиска для групп, тип: *string* `defaultDomain` - домен по умолчанию, тип: *string* `nestedGroups` - получить вложенные группы, тип: *string*. Допустимые значения: `true`, `false`. ### InternalDBAuth `differentForEachHost` - разные пользователи для каждого хоста, тип: *string*. Допустимые значения: `true`, `false`. `reverseDns` - обратный DNS, тип: *string*. Допустимые значения: `true`, `false`. `acceptProxy` - разрешить прокси, тип: *string*. Допустимые значения: `true`, `false`. ### RegexLdapAuthenticator `host` - адрес или имя LDAP сервера, тип: *string* `username` - имя пользователя, тип: *string* `password` - пароль, тип: *string* `ldapBase` - база поиска, тип: *string* `port` - порт LDAP сервера, тип: *string* `ssl` - использовать SSL, тип: *string*. Допустимые значения: `true`, `false`. `timeout` - таймаут подключения, тип: *string* `userClass` - класс для пользователей LDAP, тип: *string* `userIdAttr` - атрибут идентификатора пользователя, тип: *string* `groupNameAttr` - атрибуты имени группы, тип: *string* `userNameAttr` - атрибут имени пользователя, тип: *string* `altClass` - альтернативный класс для поиска групп, тип: *string* ### SimpleLdapAuthenticator `host` - адрес или имя LDAP сервера, тип: *string* `username` - имя пользователя, тип: *string* `password` - пароль, тип: *string* `ldapBase` - база поиска, тип: *string* `port` - порт LDAP сервера, тип: *string* `ssl` - использовать SSL, тип: *string*. Допустимые значения: `true`, `false`. `timeout` - таймаут подключения, тип: *string* `userClass` - класс для пользователей LDAP, тип: *string* `groupClass` - класс для групп LDAP, тип: *string* `userIdAttr` - атрибут идентификатора пользователя, тип: *string* `groupIdAttr` - атрибут идентификатора группы, тип: *string* `memberAttr` - атрибут членства в группе, тип: *string* `userNameAttr` - атрибут имени пользователя, тип: *string* ### SAML20Authenticator `privateKey` - приватный ключ, тип: *string* `serverCertificate` - сертификат, тип: *string* `idpMetadata` - метаданные IDP, тип: *string* `userNameAttr` - атрибут имени пользователя, тип: *string* `groupNameAttr` - атрибуты имени группы, тип: *string* `realNameAttr` - атрибуты реального имени пользователя, тип: *string* `entityID` - идентификатор SP, тип: *string* `usePassword` - использовать пароль, тип: *string*. Допустимые значения: `true`, `false`. `pwdAttr` - атрибут пароля, тип: *string* ## Параметры транспортов ### RDPTransport `useEmptyCreds` - пропустить данные аккаунта, тип: *string*. Допустимые значения: `true`, `false`. `fixedName` - имя пользователя, тип: *string* `fixedPassword` - пароль, тип: *string* `withoutDomain` - без домена, тип: *string*. Допустимые значения: `true`, `false`. `fixedDomain` - домен, тип: *string* `allowSmartcards` - разрешить смарткарты, тип: *string*. Допустимые значения: `true`, `false`. `allowPrinters` - разрешить принтеры, тип: *string*. Допустимые значения: `true`, `false`. `allowDrives` - политика локальных дисков, тип: *string*. Допустимые значения: `true` - allow any, `dynamic` - allow PnP, `false` - allow none. `enforceDrives` - принудительное подключение дисков, тип: *string* `allowSerials` - разрешить серийные порты, тип: *string*. Допустимые значения: `true`, `false`. `allowClipboard` - включить буфер обмена, тип: *string*. Допустимые значения: `true`, `false`. `allowAudio` - включить звук, тип: *string*. Допустимые значения: `true`, `false`. `allowWebcam` - включить веб-камеру, тип: *string*. Допустимые значения: `true`, `false`. `usbRedirection` - проброс USB, тип: *string*. Допустимые значения параметра `usbRedirection`: * `true` - Allow all * `false` - Allow none * `{ca3e7ab9-b4c3-4ae6-8251-579ef933890f}` - Cameras * `{4d36e967-e325-11ce-bfc1-08002be10318}` - Disk Drives * `{4d36e979-e325-11ce-bfc1-08002be10318}` - Printers * `{50dd5230-ba8a-11d1-bf5d-0000f805f530}` - Smartcards * `{745a17a0-74d3-11d0-b6fe-00a0c90f57da}` - HIDs `wallpaper` - обои/темы, тип: *string*. Допустимые значения: `true`, `false`. `multimon` - несколько мониторов, тип: *string*. Допустимые значения: `true`, `false`. `aero` - разрешить композицию рабочего стола, тип: *string*. Допустимые значения: `true`, `false`. `smooth` - сглаживание шрифтов, тип: *string*. Допустимые значения: `true`, `false`. `showConnectionBar` - панель подключения, тип: *string*. Допустимые значения: `true`, `false`. `credssp` - поддержка Credssp, тип: *string*. Допустимые значения: `true`, `false`. `rdpPort` - порт RDP, тип: *string* `screenSize` - размер экрана, тип: *string*. Для полноэкранного режима используйте значение `-1x-1` `colorDepth` - глубина цвета, тип: *string* `alsa` - использовать Alsa, тип: *string*. Допустимые значения: `true`, `false`. `multimedia` - оптимизация видеопотока, тип: *string*. Допустимые значения: `true`, `false`. `printerString` - строка принтера, тип: *string* `smartcardString` - строка Smartcard, тип: *string* `customParameters` - дополнительные параметры Linux, тип: *string* `allowMacMSRDC` - разрешить клиент Microsoft RDP, тип: *string*. Допустимые значения: `true`, `false`. `customParametersMAC` - дополнительные параметры MacOS, тип: *string* ### TSRDPTransport `tunnelServer` - туннельный сервер, тип: *string* `tunnelWait` - время ожидания туннеля, тип: *string* `verifyCertificate` - проверка SSL-сертификата, тип: *string*. Допустимые значения: `true`, `false`. > Остальные параметры аналогичны типу транспорта `RDPTransport`. ### RATransport `fixedApp` - алиас приложения, тип: *string* > Остальные параметры аналогичны типу транспорта `RDPTransport`. ### TRATransport `fixedApp` - алиас приложения, тип: *string* > Остальные параметры аналогичны типу транспорта `TSRDPTransport`. ### HTML5RDPTransport `guacamoleServer` - туннельный сервер, тип: *string* `useGlyptodonTunnel` - использовать туннель Glyptodon Enterprise, тип: *string*. Допустимые значения: `true`, `false`. `useEmptyCreds` - пропустить данные аккаунта, тип: *string*. Допустимые значения: `true`, `false`. `fixedName` - имя пользователя, тип: *string* `fixedPassword` - пароль, тип: *string* `withoutDomain` - без домена, тип: *string*. Допустимые значения: `true`, `false`. `fixedDomain` - домен, тип: *string* `wallpaper` - показать обои, тип: *string*. Допустимые значения: `true`, `false`. `desktopComp` - разрешить композицию рабочего стола, тип: *string*. Допустимые значения: `true`, `false`. `smooth` - сглаживание шрифтов, тип: *string*. Допустимые значения: `true`, `false`. `enableAudio` - включить аудио, тип: *string*. Допустимые значения: `true`, `false`. `enableAudioInput` - включить микрофон, тип: *string*. Допустимые значения: `true`, `false`. `enablePrinting` - включить печать, тип: *string*. Допустимые значения: `true`, `false`. `enableFileSharing` - обмен файлами, тип: *string*. Допустимые значения: `true`, `false`. Допустимые значения параметра `enableFileSharing`: * `false` - Disable file sharing * `down` - Allow download only * `up` - Allow upload only * `true` - Enable file sharing `enableClipboard` - буфер обмена, тип: *string* Допустимые значения параметра `enableClipboard`: * `disabled` - Disable clipboard * `dis-copy` - Disable copy from remote * `dis-paste` - Disable paste to remote * `enabled` - Enable clipboard `serverLayout` - раскладка, тип: *string*. Значение по умолчанию (default): `-` `ticketValidity` - срок действия тикета, тип: *string* `forceNewWindow` - открывать в новом окне, тип: *string*. Допустимые значения: `true`, `false`. Допустимые значения параметра `forceNewWindow`: * `false` - Open every connection on the same window, but keeps UDS window * `true` - Force every connection to be opened on a new window * `overwrite` - Override UDS window and replace it with the connection `security` - безопасность, тип: *string* Допустимые значения параметра `security`: * `any` - Any (Allow the server to choose the type of auth) * `rdp` - RDP (Standard RDP encryption. Should be supported by all servers) * `nla` - NLA (Network Layer authentication. Requires VALID username\&password, or connection will fail) * `nla-ext` - NLA extended (Network Layer authentication. Requires VALID username\&password, or connection will fail) * `tls` - TLS (Transport Security Layer encryption) `rdpPort` - порт RDP, тип: *string* `customGEPath` - контекстный путь Glyptodon Enterprise, тип: *string* ### HTML5RATransport `guacamoleServer` - туннельный сервер, тип: *string* `useEmptyCreds` - пропустить данные аккаунта, тип: *string*. Допустимые значения: `true`, `false`. `fixedName` - имя пользователя, тип: *string* `fixedPassword` - пароль, тип: *string* `withoutDomain` - без домена, тип: *string*. Допустимые значения: `true`, `false`. `fixedDomain` - домен, тип: *string* `fixedApp` - алиас приложения, тип: *string* `wallpaper` - показать обои, тип: *string*. Допустимые значения: `true`, `false`. `desktopComp` - разрешить композицию рабочего стола, тип: *string*. Допустимые значения: `true`, `false`. `smooth` - сглаживание шрифтов, тип: *string*. Допустимые значения: `true`, `false`. `enableAudio` - включить аудио, тип: *string*. Допустимые значения: `true`, `false`. `enableAudioInput` - включить микрофон, тип: *string*. Допустимые значения: `true`, `false`. `enablePrinting` - включить печать, тип: *string*. Допустимые значения: `true`, `false`. `enableFileSharing` - обмен файлами, тип: *string*. Допустимые значения: `true`, `false`. Допустимые значения параметра `enableFileSharing`: * `false` - Disable file sharing * `down` - Allow download only * `up` - Allow upload only * `true` - Enable file sharing `enableClipboard` - буфер обмена, тип: *string* Допустимые значения параметра `enableClipboard`: * `disabled` - Disable clipboard * `dis-copy` - Disable copy from remote * `dis-paste` - Disable paste to remote * `enabled` - Enable clipboard `serverLayout` - раскладка, тип: *string*. Значение по умолчанию (default): `-` `ticketValidity` - срок действия тикета, тип: *string* `forceNewWindow` - открывать в новом окне, тип: *string*. Допустимые значения: `true`, `false`. Допустимые значения параметра `forceNewWindow`: * `false` - Open every connection on the same window, but keeps UDS window * `true` - Force every connection to be opened on a new window * `overwrite` - Override UDS window and replace it with the connection `security` - безопасность, тип: *string* Допустимые значения параметра `security`: * `any` - Any (Allow the server to choose the type of auth) * `rdp` - RDP (Standard RDP encryption. Should be supported by all servers) * `nla` - NLA (Network Layer authentication. Requires VALID username\&password, or connection will fail) * `nla-ext` - NLA extended (Network Layer authentication. Requires VALID username\&password, or connection will fail) * `tls` - TLS (Transport Security Layer encryption) `rdpPort` - порт RDP, тип: *string* ### PCoIPTransport `fixedName` - имя пользователя, тип: *string* `fixedPassword` - пароль, тип: *string* `fixedDomain` - домен, тип: *string* ### SPICETransport `serverCertificate` - сертификат, тип: *string* `fullScreen` - полноэкранный режим, тип: *string*. Допустимые значения: `true`, `false`. `usbShare` - включить USB, тип: *string*. Допустимые значения: `true`, `false`. `autoNewUsbShare` - автоподключение новых USB устройств, тип: *string*. Допустимые значения: `true`, `false`. `smartCardRedirect` - перенаправление смарт-карты, тип: *string*. Допустимые значения: `true`, `false`. ### TSSPICETransport `tunnelServer` - туннельный сервер, тип: *string* `tunnelWait` - время ожидания туннеля, тип: *string* `verifyCertificate` - проверка SSL-сертификата, тип: *string*. Допустимые значения: `true`, `false`. > Остальные параметры аналогичны типу транспорта `SPICETransport`. ### URLTransport `urlPattern` - шаблон URL, тип: *string* `forceNewWindow` - открывать в новом окне, тип: *string*. Допустимые значения: `true`, `false`. ### X2GOTransport `fixedName` - имя пользователя, тип: *string* `screenSize` - размер экрана, тип: *string*. Для полноэкранного режима используйте значение `F` `desktopType` - рабочий стол, тип: *string* Допустимые значения параметра `desktopType`: * `XFCE` - Xfce * `MATE` - Mate * `LXDE` - Lxde * `GNOME` - Gnome (see docs) * `KDE` - Kde (see docs) * `gnome-session-cinnamon` - Cinnamon 1.4 (see docs) * `gnome-session-cinnamon2d` - Cinnamon 2.2 (see docs) * `UDSVAPP` - UDS vAPP `customCmd` - строка vAPP, тип: *string* `sound` - включить звук, тип: *string*. Допустимые значения: `true`, `false`. `exports` - перенаправить домашнюю папку, тип: *string*. Допустимые значения: `true`, `false`. `speed` - скорость, тип: *string* Допустимые значения параметра `speed`: * `0` - MODEM * `1` - ISDN * `2` - ADSL * `3` - WAN * `4` - LAN `soundType` - звук, тип: *string* Допустимые значения параметра `soundType`: * `pulse` - Pulse * `esd` - ESD `keyboardLayout` - клавиатура, тип: *string* `pack` - метод сжатия, тип: *string*. Значение по умолчанию: `16m-jpeg` `quality` - качество, тип: *string* ### TX2GOTransport `tunnelServer` - туннельный сервер, тип: *string* `tunnelWait` - время ожидания туннеля, тип: *string* `verifyCertificate` - проверка SSL-сертификата, тип: *string*. Допустимые значения: `true`, `false`. > Остальные параметры аналогичны типу транспорта `X2GOTransport`. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://kb.pvhostvm.ru/hostvm-vdi/rest-api-guide/3.5/appendix.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.