Создание клиента
07 декабря 2023
ID 199650
В зависимости от типа клиента, который вы указываете при вызове метода REST API, позволяет выполнить следующие действия:
- Для клиента типа "полный":
- Добавить сведения о клиенте в базу данных Сервера интеграции.
- Создать структуру защиты клиента в Kaspersky Security Center (виртуальный Сервер администрирования, учетную запись для подключения к нему, структуру папок и групп администрирования).
- Создать в папке Multitenancy KSV LA → <Название клиента> политики включения и выключения защиты виртуальных машин с установленным Легким агентом версии Kaspersky Security для виртуальных сред 5.1 Легкий агент.
Политики включения и выключения защиты применяются, только если в виртуальной инфраструктуре клиента установлены Легкие агенты версии Kaspersky Security для виртуальных сред 5.1 Легкий агент. Подробнее см. в справке Kaspersky Security для виртуальных сред 5.1 Легкий агент.
- Добавить сведения о виртуальном Сервере администрирования клиента в базу данных Сервера интеграции.
- Для клиента типа "упрощенный": добавить сведения о клиенте в базу данных Сервера интеграции.
Метод:
POST /api/2.0/virtualization/tenants
В теле запроса вам нужно указать следующие параметры:
<tenant>
<name>{название
}</name>
<description>{описание
}</description>
<userData><![CDATA[{дополнительные сведения
}]]></userData>
<preferredViisAddress>{IP-адрес
}</preferredViisAddress>
<type>{тип клиента
}</type>
<!-- Данные в секции vKsc указываются только для клиента типа "полный" -->
<vKsc>
<user>
<name>{имя администратора
}</name>
<password>{пароль администратора
}</password>
</user>
</vKsc>
</tenant>
где:
{
название
}
– название клиента (обязательный параметр).{
описание
}
– описание клиента (необязательный параметр).{
дополнительные сведения
}
– дополнительная информация о клиенте (необязательный параметр).{
IP-адрес
}
– IP-адрес Сервера интеграции, к которому должны подключаться Легкие агенты, установленные на виртуальных машинах клиента (необязательный параметр). Указанный адрес используется по умолчанию при создании политики для Легкого агента. Если параметр не указан, в политике используется IP-адрес Сервера интеграции из запроса к REST API.{
тип клиента
}
– тип клиента: "полный" (Complete
) или "упрощенный" (Simple
) (обязательный параметр).{
имя администратора
}
– имя учетной записи администратора для подключения к виртуальному Серверу администрирования клиента (обязательный параметр при создании клиента типа "полный"). Учетная запись будет создана автоматически во время выполнения процедуры.{
пароль администратора
}
– пароль учетной записи администратора, закодированный методом Base64 (обязательный параметр при создании клиента типа "полный").
Запрос выполняется асинхронно, REST API возвращает идентификатор задачи с типом CreateTenant. С помощью задачи вы можете следить за ходом выполнения процедуры создания клиента. После завершения задачи в поле result содержится информация о клиенте, в том числе идентификатор созданного клиента, или сведения об ошибке. В случае ошибки на любом из шагов выполнения процедуры выполняется откат всех внесенных изменений.
Коды возврата:
202 (Accepted)
– запрос принят к исполнению. В ответе возвращается идентификатор задачи типа CreateTenant.400 (Bad request) VIRMT_MandatoryParameterIsNotSpecified
– в теле запроса не указан один из обязательных параметров, например название клиента.400 (Bad request) VIRMT_InvalidTenantType
– в теле запроса указан неверный тип клиента, указанный тип не существует.400 (Bad request) VIRMT_VKscCredentialsNotSpecified
– не указаны имя или пароль учетной записи администратора виртуального Сервера администрирования Kaspersky Security Center (при создании клиента типа "полный").400 (Bad request) VIRMT_InvalidViisAddressFormat
– неверный формат IP-адреса Сервера интеграции.403 (Forbidden)
– доступ к ресурсу запрещен.
Возможные коды ошибок в задаче:
KSC_ServiceNotConfigured
– не заданы параметры подключения к Kaspersky Security Center.VIRMT_TenantGroupAlreadyExists
– папка с названием, соответствующим указанному названию клиента, уже существует в Kaspersky Security Center.VIRMT_TenantWithSpecifiedNameAlreadyExists
– клиент с указанным названием уже существует в базе данных Сервера интеграции.VIRMT_PasswordNotComplyPolicy
– не удалось создать учетную запись администратора виртуального Сервера администрирования Kaspersky Security Center: указанный пароль не удовлетворяет требованиям к паролям в Kaspersky Security Center.VIRMT_UserWithSpecifiedNameAlreadyExists
– не удалось создать учетную запись администратора виртуального Сервера администрирования Kaspersky Security Center: пользователь с таким именем уже существует в Kaspersky Security Center.