Add data source pages
63
06.02.01-Data-функция-decort_kvmvm-получение-информации-о-виртуальной-машине-на-базе-KVM .md
Normal file
63
06.02.01-Data-функция-decort_kvmvm-получение-информации-о-виртуальной-машине-на-базе-KVM .md
Normal file
@@ -0,0 +1,63 @@
|
||||
_Data source_ функция **decort_kvmvm** служит для получения информации об уже существующей в облачной платформе виртуальной машине (Virtual Machine, VM), созданной на базе системы виртуализации KVM.
|
||||
|
||||
## Аргументы
|
||||
_Data source_ функция **decort_kvmvm** принимает следующие аргументы:
|
||||
|
||||
| Аргумент | Тип | Обязательный | Описание |
|
||||
| --- | --- | --- | --- |
|
||||
| name | string | :x: | Имя виртуальной машины. Для идентификации виртуальной машины по её имени также необходимо указать идентификатор ресурсной группы, которой она принадлежит (`rg_id`).<br>Обратите внимание, что имя виртуальной машины уникально только в рамках одной и той же ресурсной группы и не может быть пустым.<br>Альтернативным способом идентификации виртуальной машины является задание параметра `compute_id`. |
|
||||
| rg_id | int | :x: | Идентификатор ресурсной группы, которой принадлежит данный виртуальный сервер.<br/>Данный аргумент является обязательным, если идентификация виртуальной машины выполняется по её имени. |
|
||||
| compute_id | int | :x: | Идентификатор экземпляра _compute_, соответствующего данной виртуальной машине (подробнее о понятии _compute_ см. в разделе [Обзор облачной платформы DECORT](https://github.com/rudecs/terraform-provider-decort/wiki/03.-%D0%9E%D0%B1%D0%B7%D0%BE%D1%80-%D0%BE%D0%B1%D0%BB%D0%B0%D1%87%D0%BD%D0%BE%D0%B9-%D0%BF%D0%BB%D0%B0%D1%82%D1%84%D0%BE%D1%80%D0%BC%D1%8B-DECORT.)). Если задан этот параметр, то параметры `name` и `rg_id` игнорируются. |
|
||||
|
||||
Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному виртуальному серверу и ресурсной группе. В противном случае возникнет ошибка доступа.
|
||||
|
||||
Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://github.com/rudecs/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)).
|
||||
|
||||
## Возвращаемые значения
|
||||
В случае успешного выполнения _data source_ функция **decort_kvmvm** возвращает в указанную при вызове переменную следующие значения:
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
| --- | --- | --- |
|
||||
| account_id | int | Уникальный идентификатор подписчика-владельца ("account") данной виртуальной машины. |
|
||||
| account_name | string | Имя подписчика, которому принадлежит данная виртуальная машина. |
|
||||
| boot_disk_id | int | Идентификатор загрузочного диска виртуальной машины. |
|
||||
| boot_disk_size | int | Размер загрузочного диска в ГБ. |
|
||||
| compute_id | int | Идентификатор экземпляра _compute_, соответствующего данной виртуальной машине. |
|
||||
| cloud_init | string | Параметры cloud_init |
|
||||
| cpu | int | Количество виртуальных CPU, выделенных данному серверу. |
|
||||
| description | string | Текстовое описание виртуальной машины. |
|
||||
| driver | string | Аппаратная архитектура данной виртуальной машины. |
|
||||
| extra_disks | list of ints | Список идентификаторов дополнительных дисков, которые подключены к данной виртуальной машине помимо загрузочного диска. Если такие диски отсутствуют, то список будет пустым. |
|
||||
| id | int | Уникальный идентификатор этой виртуальной машины в облачной платформе. Всегда совпадает с `compute_id`. |
|
||||
| image_id | int | Идентификатор образа ОС, на базе которого создан загрузочный диск этой виртуальной машины. |
|
||||
| image_name | string | Имя образа ОС, на базе которого создан загрузочный диск этой виртуальной машины. |
|
||||
| name | string | Имя виртуального сервера.<br>Возвращаемое значение `name` совпадает со значением соответствующего аргумента, переданного при вызове функции. |
|
||||
| network | list of dicts | Характеристики сетевых сегментов, к которым подключен данный сервер. Формат структуры:<br/>* (string) `net_type` - тип сети, соответствующей данному подключению. "EXTNET" в случае прямого подключения во внешнюю сеть, "VINS" в случае подключения к Virtual Network Segment.<br/>* (int) `net_id` - идентификатор соответствующего сетевого сегмента: внешней сети в случае `net_type = "EXTNET"` и ViNS в случае `net_type = "VINS"`<br/>* (string) `ip_address` - IP адрес, выделенный данному подключению.<br/>* (string) `mac` - MAC адрес, назначенный соответствующему сетевому интерфейсу виртуальной машины. |
|
||||
| os_users | list of dicts | Имена и пароли пользователей гостевой ОС, установленные платформой при создании виртуального сервера. Формат структуры:<br/>* (string) `login` - учётная запись в гостевой ОС.<br/>* (string) `password` - пароль к этой учётной записи. |
|
||||
| ram | int | Объём оперативной памяти в МБ, выделенной этой виртуальной машине. |
|
||||
| rg_id | int| Идентификатор ресурсной группы, к которой принадлежит виртуальная машина. |
|
||||
| rg_name | string | Имя ресурсной группы, к которой принадлежит виртуальная машина. |
|
||||
|
||||
|
||||
## Пример использования
|
||||
В нижеприведённом примере посредством вызова _data source_ функции **decort_kvmvm** извлекается информация об уже существующем в платформе виртуальном сервере со следующими характеристиками:
|
||||
* Имя сервера _MyOldVM_;
|
||||
* Идентификатор ресурсной группы, в которой находится данный сервер - 123.
|
||||
|
||||
```terraform
|
||||
data "decort_kvmvm" "existing_vm" {
|
||||
name = "MyOldVM" # this is the name of pre-existing virtual machine
|
||||
rg_id = 123 # this is the ID of resource group, where VM named "MyOldVM" is found
|
||||
}
|
||||
# Once the above directive completes, VM ID will be accessible
|
||||
# as data.decort_kvmvm.existing_vm.id
|
||||
```
|
||||
|
||||
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://github.com/rudecs/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)).
|
||||
|
||||
Чтобы получить идентификатор ресурсной группы (аргумент `rg_id`), можно воспользоваться _data source_ функцией [decort_resgroup](https://github.com/rudecs/terraform-provider-decort/wiki/06.1-Data-%D1%84%D1%83%D0%BD%D0%BA%D1%86%D0%B8%D1%8F-decs_resgroup:-%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D0%B5-%D0%B8%D0%BD%D1%84%D0%BE%D1%80%D0%BC%D0%B0%D1%86%D0%B8%D0%B8-%D0%BE-%D1%80%D0%B5%D1%81%D1%83%D1%80%D1%81%D0%BD%D0%BE%D0%B9-%D0%B3%D1%80%D1%83%D0%BF%D0%BF%D0%B5.).
|
||||
|
||||
После успешного завершения такого вызова **decort_kvmvm** в переменной `data.decort_kvmvm.existing_vm` будут сохранены возвращаемые значения. Так, например:
|
||||
* пароль для доступа в гостевую ОС, назначенный по умолчанию при создании VM - `"data.decort_kvmvm.existing_vm.os_users.0.password`
|
||||
* идентификатор образа ОС, на базе которого была создана данная VM - `data.decort_kvmvm.existing_vm.image_id`
|
||||
* текущий объём ОЗУ - `data.decort_kvmvm.existing_vm.ram`
|
||||
@@ -0,0 +1,51 @@
|
||||
_Data source_ функция **decort_resgroup** служит для получения информации об уже существующей ресурсной группе.
|
||||
|
||||
Ресурсная группа в облачной платформе DECORT это способ группирования _compute_-ов (например, по функциональному признаку или принадлежности к одному и тому же проекту). Ресурсную группу можно рассматривать как небольшой персональный дата-центр, в котором размещаются один или несколько серверов и виртуальных сетевых сегментов (ViNS).
|
||||
|
||||
Экземпляры _compute_ (виртуальные серверы) всегда создаются в принадлежности к какой-либо ресурсной группе. Как следствие, для создания экземпляра _compute_ помимо других параметров требуется указать идентификатор целевой ресурсной группы. Для получения такого идентификатора можно воспользоваться рассматриваемой здесь _data source_ функцией **decort_resgroup**.
|
||||
|
||||
## Аргументы
|
||||
_Data source_ функция **decort_resgroup** принимает следующие аргументы:
|
||||
|
||||
| Аргумент | Тип | Обязательный | Описание |
|
||||
| --- | --- | --- | --- |
|
||||
| account_id | int | :heavy_check_mark: | Идентификатор подписчика (aka "account"), которому принадлежит данная ресурсная группа. |
|
||||
| name | string | :x: | Имя ресурсной группы, по которой требуется получить информацию. Имя ресурсной группы не может быть пустым. Обратите внимание, что имя ресурсной группы должно быть уникальным только в рамках одного и того же подписчика.<br/>Ресурсная группа идентифицируется по комбинации ID подписчика-владельца (`account_id`) и имени самой группы или по её идентификатору (`rg_id`). <br>Вы можете задать или `rg_id`, или `name`. Если задан параметр `rg_id`, то параметр `name` игнорируeтся. |
|
||||
| rg_id | int | :x: | Идентификатор ресурсной группы, по которой требуется получить информацию. Идентификатор не может быть нулевым.<br/>Вы можете задать или `rg_id`, или `name`. Если задан параметр `rg_id`, то параметр `name` игнорируeтся. |
|
||||
|
||||
|
||||
Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account` и ресурсной группе. В противном случае возникнет ошибка доступа.
|
||||
|
||||
Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://github.com/rudecs/terraform-provider-decort/wiki/03.-%D0%9E%D0%B1%D0%B7%D0%BE%D1%80-%D0%BE%D0%B1%D0%BB%D0%B0%D1%87%D0%BD%D0%BE%D0%B9-%D0%BF%D0%BB%D0%B0%D1%82%D1%84%D0%BE%D1%80%D0%BC%D1%8B-DECORT.)).
|
||||
|
||||
## Возвращаемые значения
|
||||
В случае успешного выполнения _data source_ функция **decort_resgroup** возвращает в указанную при вызове переменную следующие значения:
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
| --- | --- | --- |
|
||||
| account_id | int | Уникальный идентификатор подписчика-владельца данной ресурсной группы. |
|
||||
| account_name | string | Имя подписчика ("account"), которому принадлежит данная ресурсная группа. |
|
||||
| def_net_id | int | Уникальный идентификатор сети, установленной по умолчанию для данной ресурсной группы. Экземпляры _compute_, создаваемые в данной ресурсной группе, по умолчанию будут иметь подключение к данной сети, если при их создании явно не указано иное.<br/>Для `def_net_type = "EXTNET" в этом параметре указан идентификатор внешней сети. Для `def_net_type = "PRIVATE" - идентификатор ViNS. |
|
||||
| def_net_type | string | Тип сети, установленной по умолчанию для данной ресурсной группы. Может принимать одно из следующих значений:<br> * EXTNET - подключение во внешнюю сеть с идентификатором `def_net_id`<br> * PRIVATE - подключение в виртуальный сетевой сегмент (ViNS ) с идентификатором `def_net_id`<br> * NONE - сеть по умолчанию не задана, экземпляры _compute_ в данной ресурсной группе будут создаваться без сетевых подключений, если при их создании явно не указано иное. |
|
||||
| description | string | Текстовое описание данной ресурсной группы. |
|
||||
| id | int| Идентификатор данной ресурсной группы. |
|
||||
| name | string | Имя данной ресурсной группы. Обратите внимание, что имя ресурсной группы является уникальным только в рамках одного и того же подписчика ("account"). |
|
||||
| rg_id | int| Идентификатор данной ресурсной группы. Дублирует значение параметра `id`. |
|
||||
| quota | dict | Квоты на объем ресурсов, установленные для данной ресурсной группы, с разбивкой по количеству CPU, объему RAM, объему дисковых ресурсов, количеству внешних IP адресов и т.п. Формат структуры:<br> * (int) `cpu` - лимит на суммарное потребление процессоров [шт] в рамках данной ресурсной группы;<br> * (int) `ram` - лимит на суммарное потребление ОЗУ [МБ] в рамках данной ресурсной группы;<br> * (int) `disk` - лимит на суммарное потребление дискового пространства [ГБ] в рамках данной ресурсной группы;<br> * (int) `ext_ips` - лимит на суммарное потребление внешних IP адресов [шт] в рамках данной ресурсной группы.<br> Значение -1 означает отсутствие ограничений по данному ресурсу. |
|
||||
|
||||
|
||||
## Пример использования
|
||||
Пример вызова _data source_ функции **decort_resgroup**:
|
||||
|
||||
```terraform
|
||||
data "decort_resgroup" "target_rg" {
|
||||
name = "test" # this is the name of pre-existing resource group
|
||||
account_id = 100 # this is the ID of the account, where resource group named "test" is found
|
||||
}
|
||||
# Once the above directive completes, resource group ID will be accessible as
|
||||
# data.decort_resgroup.target_rg.id
|
||||
```
|
||||
|
||||
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://github.com/rudecs/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.) и [пример](https://github.com/rudecs/terraform-provider-decort/wiki/02.-%D0%9A%D0%BE%D1%80%D0%BE%D1%87%D0%B5,-%D0%A1%D0%BA%D0%BB%D0%B8%D1%84%D0%BE%D1%81%D0%BE%D1%84%D1%81%D0%BA%D0%B8%D0%B9!)).
|
||||
|
||||
После успешного завершения такого вызова **decort_resgroup** в переменной `data.decort_resgroup.target_rg` будут сохранены возвращаемые значения. В частности, для получения идентификатора ресурсной группы следует использовать конструкцию `data.decort_resgroup.target_rg.id`
|
||||
@@ -0,0 +1,48 @@
|
||||
_Data source_ функция **decort_disk** служит для получения информации об уже существующем диске.
|
||||
|
||||
## Аргументы
|
||||
_Data source_ функция **decort_disk** принимает следующие аргументы:
|
||||
|
||||
| Аргумент | Тип | Обязательный | Описание |
|
||||
| --- | --- | --- | --- |
|
||||
| name | string | :x: | Имя диска, по которому требуется получить информацию. Имя диска не может быть пустым.<br>Диск идентифицируется по комбинации ID подписчика-владельца (`account_id`) и имени диска или по его идентификатору (`disk_id`). <br>Вы можете задать или `disk_id`, или `name`. Если задан параметр `disk_id`, то параметры `name` и `account_id` игнорируются.<br>Обратите внимание, что имя диска НЕ является уникальным, и если в рамках указанного подписчика есть несколько дисков с одним и тем же названием, то будет выдана информация по первому из них. |
|
||||
| disk_id | int | :x: | Идентификатор диска, по которому требуется получить информацию. Идентификатор не может быть нулевым.<br>Вы можете задать или `disk_id`, или `name`. Если задан параметр `disk_id`, то параметры `name` и `account_id` игнорируются. |
|
||||
| account_id | int | :x: | Идентификатор подписчика ("account"), которому принадлежит данный диск. Не может быть нулевым.<br>Данный параметр игнорируется, если задан `disk_id`. |
|
||||
|
||||
Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account`. В противном случае возникнет ошибка доступа.
|
||||
|
||||
Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://github.com/rudecs/terraform-provider-decort/wiki/03.-%D0%9E%D0%B1%D0%B7%D0%BE%D1%80-%D0%BE%D0%B1%D0%BB%D0%B0%D1%87%D0%BD%D0%BE%D0%B9-%D0%BF%D0%BB%D0%B0%D1%82%D1%84%D0%BE%D1%80%D0%BC%D1%8B-DECORT.)).
|
||||
|
||||
## Возвращаемые значения
|
||||
В случае успешного выполнения _data source_ функция **decort_disk** возвращает в указанную при вызове переменную следующие значения:
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
| --- | --- | --- |
|
||||
| account_id | int | Уникальный идентификатор подписчика-владельца диска. |
|
||||
| account_name | string | Имя подписчика ("account"), которому принадлежит данный диск. |
|
||||
| description | string | Текстовое описание диска. |
|
||||
| disk_id | int | Идентификатор диска. Дублирует значение параметра `id`. |
|
||||
| id | int | Идентификатор диска. |
|
||||
| image_id | int | Идентификатор образа, содержимое которого было склонировано/скопировано в данный диск при его создании. 0 означает, что данный диск не создавался как клон/копия какого-либо образа. |
|
||||
| name | string | Имя диска. Обратите внимание, что имя диска НЕ является уникальным, и если в рамках одного и того же подписчика ("account") есть несколько дисков с одним и тем же названием, то используется первый из них. |
|
||||
| pool | string | Имя пула в системе хранения, на ресурсах которой размещён данный диск. |
|
||||
| sep_id | int | Идентификатор Storage Endpoint Provider (SEP). SEP это способ идентифицировать конкретную систему хранения, на ресурсах которой размещён данный диск. |
|
||||
| sep_type | string | Тип SEP. Определяет тип системы хранения и содержит одно из заданных в облачной платформе значений. |
|
||||
| size | int | Размер диска в ГБ. |
|
||||
| type | string | Тип диска с точки зрения его роли в составе _compute_. Может принимать одно из фиксированных значений:<br/>"B" - признак загрузочного диска ("boot").<br/>"D" - признак дополнительного диска ("data"). |
|
||||
|
||||
## Пример использования
|
||||
Пример вызова _data source_ функции **decort_disk**:
|
||||
|
||||
```terraform
|
||||
data "decort_disk" "my_data_disk" {
|
||||
name = "Data01" # this is the name of pre-existing disk
|
||||
account_id = 100 # this is the ID of the account, where disk named "Data01" is found
|
||||
}
|
||||
# Once the above directive completes, disk ID will be accessible as
|
||||
# data.decort_disk.my_data_disk.id
|
||||
```
|
||||
|
||||
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://github.com/rudecs/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.) и [пример](https://github.com/rudecs/terraform-provider-decort/wiki/02.-%D0%9A%D0%BE%D1%80%D0%BE%D1%87%D0%B5,-%D0%A1%D0%BA%D0%BB%D0%B8%D1%84%D0%BE%D1%81%D0%BE%D1%84%D1%81%D0%BA%D0%B8%D0%B9!)).
|
||||
|
||||
После успешного завершения такого вызова **decort_disk** в переменной `data.decort_disk.my_data_disk` будут сохранены возвращаемые значения. В частности, для получения идентификатора диска следует использовать конструкцию `data.decort_disk.my_data_disk.id`
|
||||
@@ -0,0 +1,46 @@
|
||||
_Data source_ функция **decort_vins** служит для получения информации об уже существующем виртуальном сетевом сегменте (Virtual Network Segment, ViNS).
|
||||
|
||||
## Аргументы
|
||||
_Data source_ функция **decort_vins** принимает следующие аргументы:
|
||||
|
||||
| Аргумент | Тип | Обязательный | Описание |
|
||||
| --- | --- | --- | --- |
|
||||
| name | string | :heavy_check_mark: | Имя виртуального сетевого сегмента (ViNS), по которому требуется получить информацию. Имя не может быть пустым.<br>ViNS идентифицируется по комбинации имени и идентификатора ресурсной группы (`rg_id`) или подписчика (`account_id`).<br>Обратите внимание, что имя ViNS является уникальным в рамках "account" и ресурсной группы. |
|
||||
| account_id | int | :x: | Идентификатор подписчика ("account"), в котором находится данный ViNS.<br>Данный параметр игнорируется, если задан ненулевой `rg_id`, так как в этом случае подразумевается, что осуществляется поиск ViNS на уровне указанной ресурсной группы. |
|
||||
| rg_id | int | :x: | Идентификатор ресурсной группы, в которой находится данный ViNS.<br>Если необходимо найти ViNS, созданный на уровне подписчика ("account"), то необходимо указать ненулевой `account_id`, а параметр `rg_id` не задавать. |
|
||||
|
||||
Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанной учётной записи ("account") и/или ресурсной группе. В противном случае возникнет ошибка доступа.
|
||||
|
||||
Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://github.com/rudecs/terraform-provider-decort/wiki/03.-%D0%9E%D0%B1%D0%B7%D0%BE%D1%80-%D0%BE%D0%B1%D0%BB%D0%B0%D1%87%D0%BD%D0%BE%D0%B9-%D0%BF%D0%BB%D0%B0%D1%82%D1%84%D0%BE%D1%80%D0%BC%D1%8B-DECORT.)).
|
||||
|
||||
## Возвращаемые значения
|
||||
В случае успешного выполнения _data source_ функция **decort_vins** возвращает в указанную при вызове переменную следующие значения:
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
| --- | --- | --- |
|
||||
| account_id | int | Уникальный идентификатор подписчика-владельца ViNS. |
|
||||
| account_name | string | Имя подписчика ("account"), которому принадлежит ViNS. |
|
||||
| description | string | Текстовое описание ViNS. |
|
||||
| ext_ip_addr | string | IP адрес подключения ViNS к внешней сети. Если ViNS не подключен к внешней сети, то данный параметр содержит пустую строку.<br/>Обратите внимание, что из всех ViNS, созданных на уровне одной и той же ресурсной группы, только один может иметь подключение к внешней сети. ViNS, созданные на уровне "account", не могут иметь подключений к внешним сетям. |
|
||||
| ext_net_id | int | Идентификатор внешней сети, к которой подключен данный ViNS. Признаком подключения ViNS ко внешней сети является ненулевое значение этого параметра.<br/>Обратите внимание, что из всех ViNS, созданных на уровне одной и той же ресурсной группы, только один может иметь подключение к внешней сети. ViNS, созданные на уровне "account", не могут иметь подключений к внешним сетям. |
|
||||
| id | int| Идентификатор ViNS. |
|
||||
| ipcidr | string | IP CIDR, присвоенный внутреннему сегменту данного ViNS. |
|
||||
| name | string | Имя ViNS. |
|
||||
| rg_id | int | Идентификатор ресурсной группы, на уровне которой создан ViNS. Для ViNS, существующих на уровне "account", данный параметр будет равен 0. |
|
||||
|
||||
|
||||
## Пример использования
|
||||
Пример вызова _data source_ функции **decort_vins**:
|
||||
|
||||
```terraform
|
||||
data "decort_vins" "my_vins" {
|
||||
name = "Vins01" # this is the name of pre-existing ViNS
|
||||
rg_id = 500 # this is the ID of the resource group, where ViNS named "Vins01" is found
|
||||
}
|
||||
# Once the above directive completes, ViNS ID will be accessible as
|
||||
# data.decort_vins.my_vins.id
|
||||
```
|
||||
|
||||
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://github.com/rudecs/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.) и [пример](https://github.com/rudecs/terraform-provider-decort/wiki/02.-%D0%9A%D0%BE%D1%80%D0%BE%D1%87%D0%B5,-%D0%A1%D0%BA%D0%BB%D0%B8%D1%84%D0%BE%D1%81%D0%BE%D1%84%D1%81%D0%BA%D0%B8%D0%B9!)).
|
||||
|
||||
После успешного завершения такого вызова **decort_vins** в переменной `data.decort_vins.my_vins` будут сохранены возвращаемые значения. В частности, для получения идентификатора ViNS следует использовать конструкцию `data.decort_vins.my_vins.id`
|
||||
@@ -0,0 +1,38 @@
|
||||
_Data source_ функция **decort_account** служит для получения информации о подписчике ("account"), к ресурсам которого имеет доступ данный пользователь. Основной сценарий применения данной функции - получить цифровой идентификатор подписчика по его имени, чтобы в дальнейшем использовать этот идентификатор для управления ресурсами.
|
||||
|
||||
## Аргументы
|
||||
**Внимание:** в качестве параметра должен быть **обязательно** передан хотя бы один из аргументов.
|
||||
_Data source_ функция **decort_account** принимает следующие аргументы:
|
||||
|
||||
| Аргумент | Тип | Обязательный | Описание |
|
||||
| --- | --- | --- | --- |
|
||||
| name | string | :x: | Имя подписчика, по которому требуется получить информацию. Имя не может быть пустым.<br>Вы можете задать или `account_id`, или `name`. Если задан параметр `account_id`, то параметр `name` игнорируется. |
|
||||
| account_id | int | :x: | Идентификатор подписчика, по которому требуется получить информацию. Не может быть нулевым.<br>Если задан данный параметр, то параметр `name` игнорируется. |
|
||||
|
||||
Пользователь облачной платформы, от лица которого происходит обращение к данной функции, должен иметь доступ к указанному `account`. В противном случае возникнет ошибка доступа.
|
||||
|
||||
Пользователь облачной платформы задается на стадии инициализации Terraform провайдера DECORT (см. [подробности](https://github.com/rudecs/terraform-provider-decort/wiki/03.-%D0%9E%D0%B1%D0%B7%D0%BE%D1%80-%D0%BE%D0%B1%D0%BB%D0%B0%D1%87%D0%BD%D0%BE%D0%B9-%D0%BF%D0%BB%D0%B0%D1%82%D1%84%D0%BE%D1%80%D0%BC%D1%8B-DECORT.)).
|
||||
|
||||
## Возвращаемые значения
|
||||
В случае успешного выполнения _data source_ функция **decort_disk** возвращает в указанную при вызове переменную следующие значения:
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
| --- | --- | --- |
|
||||
| account_id | int | Уникальный идентификатор подписчика. |
|
||||
| account_name | string | Имя подписчика. |
|
||||
| status | string | Текущий статус подписчика. |
|
||||
|
||||
## Пример использования
|
||||
Пример вызова _data source_ функции **decort_account**:
|
||||
|
||||
```terraform
|
||||
data "decort_account" "my_account" {
|
||||
name = "MyAccount" # this is the name of the account, which ID we want to get
|
||||
}
|
||||
# Once the above directive completes, accountID will be accessible as
|
||||
# data.decort_account.my_account.id
|
||||
```
|
||||
|
||||
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://github.com/rudecs/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.) и [пример](https://github.com/rudecs/terraform-provider-decort/wiki/02.-%D0%9A%D0%BE%D1%80%D0%BE%D1%87%D0%B5,-%D0%A1%D0%BA%D0%BB%D0%B8%D1%84%D0%BE%D1%81%D0%BE%D1%84%D1%81%D0%BA%D0%B8%D0%B9!)).
|
||||
|
||||
После успешного завершения такого вызова **decort_account** в переменной `data.decort_account.my_account` будут сохранены возвращаемые значения. В частности, для получения идентификатора подписчика следует использовать конструкцию `data.decort_account.my_account.id`
|
||||
@@ -0,0 +1,79 @@
|
||||
Функция доступна в провайдере версии 2.0 и выше.
|
||||
|
||||
**Внимание:** необходимы права администратора.
|
||||
|
||||
_Data source_ функция **decort_image_list** служит для получения информации об имеющихся в облачной платформе образах. Образы это дисковые ресурсы, уже содержащие некоторые данные, для которых реализован механизм быстрого клонирования/копирования в новый диск.
|
||||
|
||||
Основной сценарий использования таких ресурсов это создание каталогов образов операционных систем (ОС), на базе которых создаются загрузочные диски для _compute_. Также с их помощью можно хранить эталонную информацию, требующуюся для работы приложений, например, файлы баз данных.
|
||||
|
||||
Образ ОС является основной для создания новых виртуальных серверов, так как из него формируется загрузочный диск сервера. Как следствие, для создания виртуального сервера помимо других параметров требуется указать идентификатор нужного образа ОС. Для получения всех доступных идентификаторов можно воспользоваться _data source_ функцией **decort_image_list**.
|
||||
|
||||
## Аргументы
|
||||
_Data source_ функция **decort_image_list** принимает следующие аргументы:
|
||||
|
||||
| Аргумент | Тип | Обязательный | Описание |
|
||||
| --- | --- | --- | --- |
|
||||
| page | int | :x: | Номер страниц |
|
||||
| size | int | :x: | Размер страницы |
|
||||
| sep_id | int | :x: | Фильтр результата по storage endpoint provider ID |
|
||||
| shared_with | int | :x: |Фильтр результата по доступности образа различным аккаунтам |
|
||||
|
||||
## Возвращаемые значения
|
||||
В случае успешного выполнения _data source_ функция **decort_image_list** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров:
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
| --- | --- | --- |
|
||||
| account_id | int | accountId привязки образа |
|
||||
| architecture | string | Архитектура образа, возможен вариант X86_64 или PPC64_LE |
|
||||
| boot_type | string | Тип запуска ОС - bios или uefi |
|
||||
| bootable | bool | Является ли образ загрузочным |
|
||||
| computeci_id | int | ID вычислительного ресурса |
|
||||
| desc | string | Описание образа |
|
||||
| drivers | []string | Список используемых драйверов |
|
||||
| enabled | bool | Доступность образа |
|
||||
| gid | int | ID платформы, где образ будет создан |
|
||||
| guid | int | Внутренний id образа, совпадает с image_id |
|
||||
| history | object{id: int, guid: int, timestamp: int} | История обновлений образа |
|
||||
| hot_resize | bool | Использует ли машина горячее изменение размера образа |
|
||||
| image_type | string | Тип образа: linux, windows или другой |
|
||||
| last_modified | int | Дата последнего изменения |
|
||||
| link_to | int | Привязка к образу, используется в виртуальных образах |
|
||||
| meta | []string | Мета информация об образе |
|
||||
| milestones | int | Вехи |
|
||||
| name | string | Название образа |
|
||||
| password | string | Пароль для образа |
|
||||
| password_dl | string | Пароль для загрузки двоичных файлов |
|
||||
| permanently | bool | Удаление образа: мгновенное или нет |
|
||||
| pool_name | string | Пул, в котором был создан образ |
|
||||
| provider_name | string | Наименование провайдера |
|
||||
| purge_attempts | int | Попытки |
|
||||
| reference_id | string | ID ссылки |
|
||||
| res_id | string | ID ресурса |
|
||||
| res_name | string | Наименование ресурса |
|
||||
| rescuecd | bool | CD или нет |
|
||||
| sep_id | int | storage endpoint provider ID |
|
||||
| size | int | Размер образа |
|
||||
| status | string | Статус образа |
|
||||
| tech_status | string | Технический статус |
|
||||
| unc_path | string | unc path |
|
||||
| url | string | Адрес, которого осуществлялась загрузка образа |
|
||||
| username | string | Имя пользователя образа |
|
||||
| username_dl | string | Имя пользователя для загрузки двоичных файлов |
|
||||
| version | string | Версия |
|
||||
|
||||
## Пример использования
|
||||
Пример вызова _data source_ функции **decort_image_list**:
|
||||
```terraform
|
||||
data "decort_image_list" "il" {
|
||||
#page = 2
|
||||
#size = 3
|
||||
#sep_id = 123
|
||||
#shared_with = 123
|
||||
}
|
||||
# once the above directive completes, images will be accessible
|
||||
# as data.decort_image_list.il.items
|
||||
```
|
||||
|
||||
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://github.com/rudecs/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)).
|
||||
|
||||
После успешного завершения такого вызова **decort_image_list** в переменной `data.decort_image_list.il` будут сохранены возвращаемые значения.
|
||||
@@ -0,0 +1,75 @@
|
||||
Функция доступна в провайдере версии 2.0 и выше.
|
||||
|
||||
**Внимание:** необходимы права администратора.
|
||||
|
||||
_Data source_ функция **decort_image** служит для получения информации об имеющихся в облачной платформе образах. Образы это дисковые ресурсы, уже содержащие некоторые данные ("golden image"), для которых реализован механизм быстрого клонирования/копирования в новый диск.
|
||||
|
||||
Основной сценарий использования таких ресурсов это создание каталогов образов операционных систем (ОС), на базе которых создаются загрузочные диски для _compute_. Также с их помощью можно хранить эталонную информацию, требующуюся для работы приложений, например, файлы баз данных.
|
||||
|
||||
Образ ОС является основной для создания новых виртуальных серверов, так как из него формируется загрузочный диск сервера. Как следствие, для создания виртуального сервера помимо других параметров требуется указать идентификатор нужного образа ОС. Для получения такого идентификатора можно воспользоваться _data source_ функцией **decort_image**.
|
||||
|
||||
## Аргументы
|
||||
_Data source_ функция **decort_image** принимает следующие аргументы:
|
||||
|
||||
| Аргумент | Тип | Обязательный | Описание |
|
||||
| --- | --- | --- | --- |
|
||||
| image_id | int | :heavy_check_mark: | ID образа, информацию по которому требуется получить. |
|
||||
|
||||
ID необходимо образа можно взять вызвав [decort_image_list](https://github.com/rudecs/terraform-provider-decort/wiki/06.6-Data-функция-decort_image_list:-получение-информации-об-образах)
|
||||
|
||||
## Возвращаемые значения
|
||||
В случае успешного выполнения _data source_ функция **decort_image** возвращает в указанную при вызове переменную следующие значения:
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
| --- | --- | --- |
|
||||
| account_id | int | accountId привязки образа |
|
||||
| architecture | string | Архитектура образа, возможен вариант X86_64 или PPC64_LE |
|
||||
| boot_type | string | Тип запуска ОС - bios или uefi |
|
||||
| bootable | bool | Является ли образ загрузочным |
|
||||
| computeci_id | int | ID вычислительного ресурса |
|
||||
| desc | string | Описание образа |
|
||||
| drivers | []string | Список используемых драйверов |
|
||||
| enabled | bool | Доступность образа |
|
||||
| gid | int | ID платформы, где образ будет создан |
|
||||
| guid | int | Внутренний id образа, совпадает с image_id |
|
||||
| history | object{id: int, guid: int, timestamp: int} | История обновлений образа |
|
||||
| hot_resize | bool | Использует ли машина горячее изменение размера образа |
|
||||
| image_type | string | Тип образа: linux, windows или другой |
|
||||
| last_modified | int | Дата последнего изменения |
|
||||
| link_to | int | Привязка к образу, используется в виртуальных образах |
|
||||
| meta | []string | Мета информация об образе |
|
||||
| milestones | int | Вехи |
|
||||
| name | string | Название образа |
|
||||
| password | string | Пароль для образа |
|
||||
| password_dl | string | Пароль для загрузки двоичных файлов |
|
||||
| permanently | bool | Удаление образа: мгновенное или нет |
|
||||
| pool_name | string | Пул, в котором был создан образ |
|
||||
| provider_name | string | Наименование провайдера |
|
||||
| purge_attempts | int | Попытки |
|
||||
| reference_id | string | ID ссылки |
|
||||
| res_id | string | ID ресурса |
|
||||
| res_name | string | Наименование ресурса |
|
||||
| rescuecd | bool | CD или нет |
|
||||
| sep_id | int | storage endpoint provider ID |
|
||||
| size | int | Размер образа |
|
||||
| status | string | Статус образа |
|
||||
| tech_status | string | Технический статус |
|
||||
| unc_path | string | unc path |
|
||||
| url | string | Адрес, которого осуществлялась загрузка образа |
|
||||
| username | string | Имя пользователя образа |
|
||||
| username_dl | string | Имя пользователя для загрузки двоичных файлов |
|
||||
| version | string | Версия |
|
||||
|
||||
## Пример использования
|
||||
Пример вызова _data source_ функции **decort_image**:
|
||||
```terraform
|
||||
data "decort_image" "my_img" {
|
||||
image_id = 1234
|
||||
}
|
||||
# once the above directive completes, image ID will be accessible
|
||||
# as data.decort_image.my_img.id
|
||||
```
|
||||
|
||||
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://github.com/rudecs/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)).
|
||||
|
||||
После успешного завершения такого вызова **decort_image** в переменной `data.decort_image.my_img` будут сохранены возвращаемые значения. В частности, для получения идентификатора образа следует использовать конструкцию `data.decort_image.my_img.id`
|
||||
51
06.02.08-Data-функция-decort_image_list_stacks-получение-информации-о-доступных-для-образа-stacks.md
Normal file
51
06.02.08-Data-функция-decort_image_list_stacks-получение-информации-о-доступных-для-образа-stacks.md
Normal file
@@ -0,0 +1,51 @@
|
||||
Функция доступна в провайдере версии 2.0 и выше.
|
||||
|
||||
**Внимание:** необходимы права администратора.
|
||||
|
||||
_Data source_ функция **decort_image_list_stacks** служит для получения информации об имеющихся в облачной платформе доступных образу stacks. Образы это дисковые ресурсы, уже содержащие некоторые данные, для которых реализован механизм быстрого клонирования/копирования в новый диск. Stacks - единица платформы, в которой хранятся в том числе и образы. Из других stacks к образу доступа нет.
|
||||
|
||||
## Аргументы
|
||||
_Data source_ функция **decort_image_list_stacks** принимает следующие аргументы:
|
||||
|
||||
| Аргумент | Тип | Обязательный | Описание |
|
||||
| --- | --- | --- | --- |
|
||||
| image_id | int | :heavy_check_mark: | ID образа |
|
||||
| page | int | :x: | Номер страницы |
|
||||
| size | int | :x: | Размер страницы |
|
||||
|
||||
|
||||
## Возвращаемые значения
|
||||
В случае успешного выполнения _data source_ функция **decort_image_list_stacks** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров:
|
||||
| Параметр | Тип | Описание |
|
||||
| --- | --- | --- |
|
||||
| api_key | string | Ключ api |
|
||||
| api_url | string | Адрес api |
|
||||
| app_id | string | ID приложения |
|
||||
| desc | string | Описание |
|
||||
| drivers | []string | Список драйверов |
|
||||
| error | int | Номер ошибки |
|
||||
| guid | int | Внутренний id |
|
||||
| id | int | ID |
|
||||
| images | []int | Список доступных образов на stack |
|
||||
| login | string | Логин пользователя |
|
||||
| name | string | Наименование stacks |
|
||||
| passwd | string | Пароль |
|
||||
| reference_id | string | ID ссылки |
|
||||
| status | string | Статус |
|
||||
| type | string | Тип |
|
||||
|
||||
## Пример использования
|
||||
Пример вызова _data source_ функции **decort_image_list_stacks**:
|
||||
```terraform
|
||||
data "decort_image_list_stacks" "ils" {
|
||||
image_id = 1234
|
||||
#page = 2
|
||||
#size = 3
|
||||
}
|
||||
# once the above directive completes, will be accessible
|
||||
# as data.decort_image_list_stacks.ils.items
|
||||
```
|
||||
|
||||
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://github.com/rudecs/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)).
|
||||
|
||||
После успешного завершения такого вызова **decort_image_list_stacks** в переменной `data.decort_image_list_stacks.ils` будут сохранены возвращаемые значения.
|
||||
70
06.02.14-Data-функция-decort_rg_list-получение-информации-о-всех-ресурсных-группах.md
Normal file
70
06.02.14-Data-функция-decort_rg_list-получение-информации-о-всех-ресурсных-группах.md
Normal file
@@ -0,0 +1,70 @@
|
||||
Функция доступна в провайдере версии 2.3 и выше.
|
||||
|
||||
_Data source_ функция **decort_rg_list** служит для получения информации об имеющихся ресурсных группах.
|
||||
|
||||
## Аргументы
|
||||
_Data source_ функция **decort_rg_list** принимает следующие аргументы:
|
||||
| Аргумент | Тип | Обязательный | Описание |
|
||||
| --- | --- | --- | --- |
|
||||
| includedeleted | bool | :x: | Включение удаленных rg в результат поиска |
|
||||
| page | int | :x: | Номер страниц |
|
||||
| size | int | :x: | Размер страницы |
|
||||
|
||||
|
||||
## Возвращаемые значения
|
||||
В случае успешного выполнения _data source_ функция **decort_rg_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
| --- | --- | --- |
|
||||
| account_id | int | ID аккаунта - владельца ресурсной группы |
|
||||
| account_name | string | Имя аккаунта - владельца ресурсной группы |
|
||||
| acl | []Struct{<br/>explicit bool<br/>guid string<br/>right string<br/>status string<br/>type string<br/>user_group_id string<br/>} | Более подробная информация об аккаунтах, имеющих доступ к ресурсной группе<br/>Явно ли указан доступ<br/>guid аккаунта<br/>Права доступа<br/>Статус аккаунта<br/>Тип аккаунта<br/>Идентификатор пользователя-владельца аккаунта<br/> <br/> |
|
||||
| created_by | string | Информация о создателе группы |
|
||||
| created_time | int | Время создания группы |
|
||||
| def_net_id | int | id сети по-умолчанию |
|
||||
| def_net_type | string | Тип сети по-умолчанию |
|
||||
| deleted_by | string | Информация о том, кто удалил группу |
|
||||
| deleted_time | int | Время удаления группы |
|
||||
| desc | string | Описание группы |
|
||||
| gid | int | Grid id |
|
||||
| guid | int | Внутренний идентификатор ресурсной группы |
|
||||
| rg_id | int | Идентификатор ресурсной группы |
|
||||
| lock_status | string | Статус блокировки ресурсной группы |
|
||||
| name | string | Название ресурсной группы |
|
||||
| register_computes | bool | Имеются ли зарезервированные выч. мощности |
|
||||
| resource_limits | Struct{<br/>cu_c float<br/>cu_d float<br/>cu_i float<br/>cu_m float<br/>cu_np float<br/>gpu_units float<br/>} | Ограничения ресурсов<br/>Кол-во ядер<br/>Размер диска, ГБ<br/>Число публичных ip адресов<br/>Размер RAM, МБ<br/>Объем трафика, ГБ<br/>Кол-вол графических ядер<br/> <br/> |
|
||||
| secret | string | Секрет группы |
|
||||
| status | string | Статус группы |
|
||||
| updated_by | string | Кем группа была обновлена в последний раз |
|
||||
| updated_time | int | Время последнего обновления |
|
||||
| vins | []int | Список идентификаторов виртуальных сетей |
|
||||
| vms | []int | Список идентификаторов виртуальных машин (устаревшее) |
|
||||
|
||||
## Пример использования
|
||||
Пример вызова _data source_ функции **decort_rg_list**:
|
||||
```terraform
|
||||
data "decort_rg_list" "rl" {
|
||||
#включение удаленных rg в результат поиска
|
||||
#опциональный параметр
|
||||
#тип - булев тип
|
||||
#по-умолчанию - false
|
||||
#includedeleted = true
|
||||
|
||||
#номер страницы для отображения
|
||||
#опциональный параметр, тип - число
|
||||
#если не задан - выводятся все доступные данные
|
||||
#page = 2
|
||||
|
||||
#размер страницы
|
||||
#опциональный параметр, тип - число
|
||||
#если не задан - выводятся все доступные данные
|
||||
#size = 3
|
||||
|
||||
}
|
||||
# once the above directive completes, rg list will be accessible
|
||||
# as data.decort_rg_list.rl.items
|
||||
```
|
||||
|
||||
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://github.com/rudecs/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)).
|
||||
|
||||
После успешного завершения такого вызова **decort_rg_list** в переменной `data.decort_rg_list.rl` будут сохранены возвращаемые значения.
|
||||
@@ -0,0 +1,84 @@
|
||||
Функция доступна в провайдере версии 2.3 и выше.
|
||||
|
||||
_Data source_ функция **decort_disk_list** служит для получения информации об имеющихся дисках.
|
||||
|
||||
## Аргументы
|
||||
_Data source_ функция **decort_disk_list** принимает следующие аргументы:
|
||||
| Аргумент | Тип | Обязательный | Описание |
|
||||
| --- | --- | --- | --- |
|
||||
| account_id | int | :x: | id аккаунта для получения списка дисков |
|
||||
| type | string | :x: | Тип диска. Возможные типы: "b" - boot_disk, "d" - data_disk |
|
||||
| page | int | :x: | Номер страниц |
|
||||
| size | int | :x: | Размер страницы |
|
||||
|
||||
|
||||
## Возвращаемые значения
|
||||
В случае успешного выполнения _data source_ функция **decort_disk_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
| --- | --- | --- |
|
||||
| account_id | int | id аккаунта |
|
||||
| account_name | string | имя аккаунта |
|
||||
| created_time | int | Время создания диска |
|
||||
| deleted_time | int | Время удаления диска |
|
||||
| desc | string | Описание диска |
|
||||
| destruction_time | int | Время уничтожения диска |
|
||||
| devicename | string | Имя устройства |
|
||||
| gid | int | Grid id |
|
||||
| disk_id | int | id диска |
|
||||
| image_id | int | id образа |
|
||||
| images | []int | id образов |
|
||||
| iotune | Struct{<br/>total_iops_sec int<br/>} | Информация об IO-интерфейсах<br/>Общее кол-во операций в секунду<br/> <br/> |
|
||||
| machine_id | int | id маишны (устаревшее) |
|
||||
| machine_name | string | Наименование машины (устаревшее) |
|
||||
| name | string | Наименование диска |
|
||||
| order | int | Номер диска в последовательности |
|
||||
| params | string | Параметры диска |
|
||||
| parent_id | int | id родителя |
|
||||
| pci_slot | int | id pci слота |
|
||||
| pool | string | Наименование пула диска |
|
||||
| purge_time | int | Время удаления |
|
||||
| res_id | string | Идентификатор ресурса |
|
||||
| res_name | string | Наименование ресурсов |
|
||||
| role | string | Роль диска
|
||||
| sep_id | int | id sep |
|
||||
| sep_type | string | Тип sep |
|
||||
| size_max | int | Максимальный размер диска |
|
||||
| snapshots | []Struct{<br/>guid string<br/>label string<br/>res_id string<br/>snap_set_guid string<br/>snap_set_time int<br/>timestamp int<br/>} | Информация о снимках состояний диска<br/>guid снимка<br/>Наименование снимка<br/>id ресурса снимка<br/>Установленный guid снимка<br/>Установленное время снимка<br/>Время снимка<br> <br/> |
|
||||
| status | string | Статус диска
|
||||
| tech_status | string | Технический статус диска |
|
||||
| type | string | Тип диска
|
||||
| vmid | int | id виртуальной машины |
|
||||
|
||||
## Пример использования
|
||||
Пример вызова _data source_ функции **decort_disk_list**:
|
||||
```terraform
|
||||
data "decort_disk_list" "dl" {
|
||||
#id аккаунта для получения списка дисков
|
||||
#опциональный параметр
|
||||
#тип - число
|
||||
#account_id = 11111
|
||||
|
||||
#тип диска
|
||||
#опциональный параметр
|
||||
#тип - строка
|
||||
#возможные типы: "b" - boot_disk, "d" - data_disk
|
||||
#type = "d"
|
||||
|
||||
#кол-во страниц для вывода
|
||||
#опциональный параметр
|
||||
#тип - число
|
||||
#page = 1
|
||||
|
||||
#размер страницы
|
||||
#опциональный параметр
|
||||
#тип - число
|
||||
#size = 1
|
||||
}
|
||||
# once the above directive completes, disk list will be accessible
|
||||
# as data.decort_disk_list.dl.items
|
||||
```
|
||||
|
||||
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://github.com/rudecs/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)).
|
||||
|
||||
После успешного завершения такого вызова **decort_disk_list** в переменной `data.decort_disk_list.dl` будут сохранены возвращаемые значения.
|
||||
65
06.02.16-Data-функция-decort_vins_list-получение-информации-о-всех-виртуальных-сетях.md
Normal file
65
06.02.16-Data-функция-decort_vins_list-получение-информации-о-всех-виртуальных-сетях.md
Normal file
@@ -0,0 +1,65 @@
|
||||
Функция доступна в провайдере версии 2.3 и выше.
|
||||
|
||||
_Data source_ функция **decort_vins_list** служит для получения информации об имеющихся виртуальных сетях.
|
||||
|
||||
## Аргументы
|
||||
_Data source_ функция **decort_vins_list** принимает следующие аргументы:
|
||||
| Аргумент | Тип | Обязательный | Описание |
|
||||
| --- | --- | --- | --- |
|
||||
| include_deleted | bool | :x: | Включение удаленных vins в результат поиска |
|
||||
| page | int | :x: | Номер страниц |
|
||||
| size | int | :x: | Размер страницы |
|
||||
|
||||
|
||||
## Возвращаемые значения
|
||||
В случае успешного выполнения _data source_ функция **decort_vins_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
| --- | --- | --- |
|
||||
| account_id | int | ID аккаунта - владельца виртуальной сети |
|
||||
| account_name | string | Имя аккаунта - владельца виртуальной |
|
||||
| created_by | string | Информация о создателе виртуальной сети |
|
||||
| created_time | int | Время создания виртуальной сети |
|
||||
| deleted_by | string | Информация о том, кто удалил виртуальную сеть |
|
||||
| deleted_time | int | Время удаления виртуальной сети |
|
||||
| external_ip | string | Внешний ip - адрес |
|
||||
| vins_id | int | Идентификатор виртуальной сети |
|
||||
| vins_name | string | Название виртуальной сети |
|
||||
| network | string | Сеть |
|
||||
| rg_id | int | Идентификатор ресурсной группы |
|
||||
| rg_name | string | Название ресурсной группы |
|
||||
| status | string | Статус виртуальной сети |
|
||||
| updated_by | string | Кем виртуальная сеть была обновлена в последний раз |
|
||||
| updated_time | int | Время последнего обновления |
|
||||
| vxlan_id | int | Идентификатор vxlan |
|
||||
|
||||
## Пример использования
|
||||
Пример вызова _data source_ функции **decort_vins_list**:
|
||||
```terraform
|
||||
data "decort_vins_list" "vl" {
|
||||
#включение удаленных vins в результат
|
||||
#опциональный параметр
|
||||
#тип - булев тип
|
||||
#если не задан - выводятся все неудаленные данные
|
||||
#include_deleted = true
|
||||
|
||||
#номер страницы для отображения
|
||||
#опциональный параметр
|
||||
#тип - число
|
||||
#если не задан - выводятся все доступные данные
|
||||
#page = 1
|
||||
|
||||
#размер страницы
|
||||
#опциональный параметр
|
||||
#тип - число
|
||||
#если не задан - выводятся все доступные данные
|
||||
#size = 1
|
||||
|
||||
}
|
||||
# once the above directive completes, vins list will be accessible
|
||||
# as data.decort_vins_list.vl.items
|
||||
```
|
||||
|
||||
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://github.com/rudecs/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)).
|
||||
|
||||
После успешного завершения такого вызова **decort_vins_list** в переменной `data.decort_vins_list.vl` будут сохранены возвращаемые значения.
|
||||
41
06.02.17-Data-функция-decort_account_audits_list-получение-информации-о-запросах-аккаунта.md
Normal file
41
06.02.17-Data-функция-decort_account_audits_list-получение-информации-о-запросах-аккаунта.md
Normal file
@@ -0,0 +1,41 @@
|
||||
Функция доступна в провайдере версии 2.3 и выше.
|
||||
|
||||
_Data source_ функция **decort_account_audits_list** служит для получения информации о запросах аккаунта.
|
||||
Информация содержит в себе данные о вызове, времени выполнения запроса, пользователе, инициирующем вызов, а так же другие данные.
|
||||
|
||||
## Аргументы
|
||||
_Data source_ функция **decort_account_audits_list** принимает следующие аргументы:
|
||||
| Аргумент | Тип | Обязательный | Описание |
|
||||
| --- | --- | --- | --- |
|
||||
| account_id | int | :heavy_check_mark: | ID аккаунта |
|
||||
|
||||
|
||||
## Возвращаемые значения
|
||||
В случае успешного выполнения _data source_ функция **decort_account_audits_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
| --- | --- | --- |
|
||||
| call | string | Адрес вызова API |
|
||||
| responsetime | float | Время ответа |
|
||||
| statuscode | int | Код ответа |
|
||||
| timestamp | float | Время получения запроса |
|
||||
| user | string | Пользователь - владелец аккаунта |
|
||||
|
||||
|
||||
## Пример использования
|
||||
Пример вызова _data source_ функции **decort_account_audits_list**:
|
||||
```terraform
|
||||
data "decort_account_audits_list" "aal" {
|
||||
#id аккаунта
|
||||
#обязательный параметр
|
||||
#тип - число
|
||||
account_id = 11111
|
||||
|
||||
}
|
||||
# once the above directive completes, account audits list will be accessible
|
||||
# as data.decort_account_audits_list.aal.items
|
||||
```
|
||||
|
||||
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://github.com/rudecs/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)).
|
||||
|
||||
После успешного завершения такого вызова **decort_account_audits_list** в переменной `data.decort_account_audits_list.aal` будут сохранены возвращаемые значения.
|
||||
54
06.02.18-Data-функция-decort_account_computes_list-получение-информации-об-используемых-аккаунтом-экземплярах-computes.md
Normal file
54
06.02.18-Data-функция-decort_account_computes_list-получение-информации-об-используемых-аккаунтом-экземплярах-computes.md
Normal file
@@ -0,0 +1,54 @@
|
||||
Функция доступна в провайдере версии 2.3 и выше.
|
||||
|
||||
_Data source_ функция **decort_account_computes_list** служит для получения информации о вычислительных мощностях (computes), которые использует аакаунт.
|
||||
|
||||
## Аргументы
|
||||
_Data source_ функция **decort_account_computes_list** принимает следующие аргументы:
|
||||
| Аргумент | Тип | Обязательный | Описание |
|
||||
| --- | --- | --- | --- |
|
||||
| account_id | int | :heavy_check_mark: | ID аккаунта |
|
||||
|
||||
|
||||
## Возвращаемые значения
|
||||
В случае успешного выполнения _data source_ функция **decort_account_computes_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
| --- | --- | --- |
|
||||
| account_id | int | ID аккаунта |
|
||||
| account_name | string | Имя аккаунта |
|
||||
| compute_id | int | ID экземпляра computes |
|
||||
| compute_name | string | Название экземпляра computes |
|
||||
| cpus | int | Кол-во используемых ядер |
|
||||
| created_by | string | Информация о создателе вычислительной мощности |
|
||||
| created_time | int | Время создания вычислительной мощности |
|
||||
| deleted_by | string | Информация о том, кто удалил вычислительную мощность |
|
||||
| deleted_time | int | Время удаления вычислительной мощности |
|
||||
| ram | int | Кол-во используемой RAM |
|
||||
| registered | bool | Флаг, показатель того, зарегистрирована ли мощность как используемая или нет |
|
||||
| rg_id | int | Идентификатор ресурсной группы |
|
||||
| rg_name | string | Название ресурсной группы |
|
||||
| status | string | Статус вычислительной мощности |
|
||||
| tech_status | string | Технический статус вычислительной мощности |
|
||||
| total_disks_size | int | Общее место, используемое дисками вычислительной мощности |
|
||||
| updated_by | string | Кем вычислительная мощность была обновлена в последний раз |
|
||||
| updated_time | int | Время последнего обновления |
|
||||
| user_managed | bool | Флаг, показывает управление пользователем вычислительной мощностью |
|
||||
| vins_connected | int | Общее число подключенных и используемых vins |
|
||||
|
||||
## Пример использования
|
||||
Пример вызова _data source_ функции **decort_account_computes_list**:
|
||||
```terraform
|
||||
data "decort_account_computes_list" "acl" {
|
||||
#id аккаунта
|
||||
#обязательный параметр
|
||||
#тип - число
|
||||
account_id = 1111
|
||||
|
||||
}
|
||||
# once the above directive completes, account computes list will be accessible
|
||||
# as data.decort_account_computes_list.acl.items
|
||||
```
|
||||
|
||||
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://github.com/rudecs/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)).
|
||||
|
||||
После успешного завершения такого вызова **decort_account_computes_list** в переменной `data.decort_account_computes_list.acl` будут сохранены возвращаемые значения.
|
||||
39
06.02.19-Data-функция-decort_account_disks_list-получение-информации-об-используемых-аккаунтом-дисках.md
Normal file
39
06.02.19-Data-функция-decort_account_disks_list-получение-информации-об-используемых-аккаунтом-дисках.md
Normal file
@@ -0,0 +1,39 @@
|
||||
Функция доступна в провайдере версии 2.3 и выше.
|
||||
|
||||
_Data source_ функция **decort_account_disks_list** служит для получения информации об используемых аккаунтом дисках.
|
||||
|
||||
## Аргументы
|
||||
_Data source_ функция **decort_account_disks_list** принимает следующие аргументы:
|
||||
| Аргумент | Тип | Обязательный | Описание |
|
||||
| --- | --- | --- | --- |
|
||||
| account_id | int | :heavy_check_mark: | ID аккаунта |
|
||||
|
||||
## Возвращаемые значения
|
||||
В случае успешного выполнения _data source_ функция **decort_account_disks_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
| --- | --- | --- |
|
||||
| disk_id | int | ID диска |
|
||||
| disk_name | string | Название диска |
|
||||
| pool | string | Название пула, к которому относится диск |
|
||||
| sep_id | int | ID sep |
|
||||
| size_max | int | Максимальный размер диска |
|
||||
| type | string | Тип диска |
|
||||
|
||||
## Пример использования
|
||||
Пример вызова _data source_ функции **decort_account_disks_list**:
|
||||
```terraform
|
||||
data "decort_account_disks_list" "adl" {
|
||||
#id аккаунта
|
||||
#обязательный параметр
|
||||
#тип - число
|
||||
account_id = 11111
|
||||
|
||||
}
|
||||
# once the above directive completes, account disks list will be accessible
|
||||
# as data.decort_account_disks_list.adl.items
|
||||
```
|
||||
|
||||
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://github.com/rudecs/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)).
|
||||
|
||||
После успешного завершения такого вызова **decort_account_disks_list** в переменной `data.decort_account_disks_list.adl` будут сохранены возвращаемые значения.
|
||||
53
06.02.20-Data-функция-decort_account_flipgroups_list-получение-информации-об-используемых-групп-с-плавающим-ip-адресом.md
Normal file
53
06.02.20-Data-функция-decort_account_flipgroups_list-получение-информации-об-используемых-групп-с-плавающим-ip-адресом.md
Normal file
@@ -0,0 +1,53 @@
|
||||
Функция доступна в провайдере версии 2.3 и выше.
|
||||
|
||||
_Data source_ функция **decort_account_flipgroups_list** служит для получения информации об используемых групп с плавающим ip-адресом.
|
||||
|
||||
## Аргументы
|
||||
_Data source_ функция **decort_account_flipgroups_list** принимает следующие аргументы:
|
||||
| Аргумент | Тип | Обязательный | Описание |
|
||||
| --- | --- | --- | --- |
|
||||
| account_id | int | :heavy_check_mark: | ID аккаунта |
|
||||
|
||||
## Возвращаемые значения
|
||||
В случае успешного выполнения _data source_ функция **decort_account_flipgroups_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
| --- | --- | --- |
|
||||
| account_id | int | ID аккаунта - владельца группы с плавающим ip-адресом |
|
||||
| client_type | string | Тип клиента |
|
||||
| conn_type | string | Тип соединения |
|
||||
| created_by | string | Информация о создателе группы с плавающим ip-адресом |
|
||||
| created_time | int | Время создания группы с плавающим ip-адресом |
|
||||
| default_gw | string | Gateway группы с плавающим ip-адресом по-умолчанию |
|
||||
| deleted_by | string | Информация о том, кто удалил группу с плавающим ip-адресом |
|
||||
| deleted_time | int | Время удаления группы с плавающим ip-адресом |
|
||||
| desc | string | Описание группы с плавающим ip-адресом |
|
||||
| gid | int | Grid id |
|
||||
| guid | int | Внутренний идентификатор группы с плавающим ip-адресом |
|
||||
| fg_id | int | ID группы с плавающим ip-адресом |
|
||||
| ip | string | IP-адрес |
|
||||
| milestones | int | Вехи |
|
||||
| fg_name | string | Название группы с плавающим ip-адресом |
|
||||
| net_id | int | ID сети |
|
||||
| net_type | string | Тип сети |
|
||||
| netmask | int | Маска сети |
|
||||
| status | string | Статус группы с плавающим ip-адресом |
|
||||
| updated_by | string | Кем группа с плавающим ip-адресом была обновлена в последний раз |
|
||||
| updated_time | int | Время последнего обновления |
|
||||
|
||||
## Пример использования
|
||||
Пример вызова _data source_ функции **decort_account_flipgroups_list**:
|
||||
```terraform
|
||||
data "decort_account_flipgroups_list" "afgl" {
|
||||
#id аккаунта
|
||||
#обязательный параметр
|
||||
#тип - число
|
||||
account_id = 1111
|
||||
}
|
||||
# once the above directive completes, account flipgroups list will be accessible
|
||||
# as data.decort_account_flipgroups_list.afgl.items
|
||||
```
|
||||
|
||||
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://github.com/rudecs/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)).
|
||||
|
||||
После успешного завершения такого вызова **decort_account_flipgroups_list** в переменной `data.decort_account_flipgroups_list.afgl` будут сохранены возвращаемые значения.
|
||||
46
06.02.21-Data-функция-decort_account_rg_list-получение-информации-о-ресурсных-группах-аккаунта.md
Normal file
46
06.02.21-Data-функция-decort_account_rg_list-получение-информации-о-ресурсных-группах-аккаунта.md
Normal file
@@ -0,0 +1,46 @@
|
||||
Функция доступна в провайдере версии 2.3 и выше.
|
||||
|
||||
_Data source_ функция **decort_account_rg_list** служит для получения информации о ресурсных группах, принадлежащих аккаунту.
|
||||
|
||||
## Аргументы
|
||||
_Data source_ функция **decort_account_rg_list** принимает следующие аргументы:
|
||||
| Аргумент | Тип | Обязательный | Описание |
|
||||
| --- | --- | --- | --- |
|
||||
| account_id | int | :heavy_check_mark: | ID аккаунта |
|
||||
|
||||
|
||||
## Возвращаемые значения
|
||||
В случае успешного выполнения _data source_ функция **decort_account_rg_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
| --- | --- | --- |
|
||||
| computes | Struct{<br/>started int<br/>stopped int <br/>} | Информация о вычислительных мощностях<br/>Кол-во запущенных<br/>Кол-во остановленных<br/> <br/> |
|
||||
| resources | Struct{<br/>consumed Struct{<br/>cpu int<br/>disksize int<br/>extips int<br/>exttraffic int<br/>gpu int<br/>ram int<br/>}<br/>limits Struct{<br/>cpu int<br/>disksize int<br/>extips int<br/>exttraffic int<br/>gpu int<br/>ram int<br/>}<br/>reserved Struct{<br/>cpu int<br/>disksize int<br/>extips int<br/>exttraffic int<br/>gpu int<br/>ram int<br/>}<br/>} | Информация о ресурсах<br/>Задействованные<br/>Кол-вол ядер<br/>Размер диска, ГБ<br/>Кол-во внешних ip-адресов<br/>Размер внешнего траффика<br/>Кол-во графических ядер<br/>Размер RAM, МБ<br/><br/>Максимально возможные значения<br/> Кол-вол ядер<br/>Размер диска, ГБ<br/>Кол-во внешних ip-адресов<br/>Размер внешнего траффика<br/>Кол-во графических ядер<br/>Размер RAM, МБ<br/><br/>Зарезервированные<br/>Кол-вол ядер<br/>Размер диска, ГБ<br/>Кол-во внешних ip-адресов<br/>Размер внешнего траффика<br/>Кол-во графических ядер<br/>Размер RAM, МБ<br/><br/> <br/> |
|
||||
| created_by | string | Информация о создателе группы |
|
||||
| created_time | int | Время создания группы |
|
||||
| deleted_by | string | Информация о том, кто удалил группу |
|
||||
| deleted_time | int | Время удаления группы |
|
||||
| rg_id | int | Идентификатор ресурсной группы |
|
||||
| rg_name | string | Название ресурсной группы |
|
||||
| milestones | int | Вехи |
|
||||
| status | string | Статус группы |
|
||||
| updated_by | string | Кем группа была обновлена в последний раз |
|
||||
| updated_time | int | Время последнего обновления |
|
||||
| vins | []int | Список идентификаторов виртуальных сетей |
|
||||
|
||||
## Пример использования
|
||||
Пример вызова _data source_ функции **decort_account_rg_list**:
|
||||
```terraform
|
||||
data "decort_account_rg_list" "argl" {
|
||||
#id аккаунта
|
||||
#обязательный параметр
|
||||
#тип - число
|
||||
account_id = 11111
|
||||
}
|
||||
# once the above directive completes, account rg list will be accessible
|
||||
# as data.decort_account_rg_list.argl.items
|
||||
```
|
||||
|
||||
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://github.com/rudecs/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)).
|
||||
|
||||
После успешного завершения такого вызова **decort_account_rg_list** в переменной `data.decort_account_rg_list.argl` будут сохранены возвращаемые значения.
|
||||
52
06.02.22-Data-функция-decort_account_vins_list-получение-информации-о-всех-сетях-аккаунта.md
Normal file
52
06.02.22-Data-функция-decort_account_vins_list-получение-информации-о-всех-сетях-аккаунта.md
Normal file
@@ -0,0 +1,52 @@
|
||||
Функция доступна в провайдере версии 2.3 и выше.
|
||||
|
||||
_Data source_ функция **decort_account_vins_list** служит для получения информации об используемых аккаунтом сетях.
|
||||
|
||||
## Аргументы
|
||||
_Data source_ функция **decort_account_vins_list** принимает следующие аргументы:
|
||||
| Аргумент | Тип | Обязательный | Описание |
|
||||
| --- | --- | --- | --- |
|
||||
| account_id | int | :heavy_check_mark: | ID аккаунта |
|
||||
|
||||
|
||||
## Возвращаемые значения
|
||||
В случае успешного выполнения _data source_ функция **decort_account_vins_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
| --- | --- | --- |
|
||||
| account_id | int | ID аккаунта - владельца виртуальной сети |
|
||||
| account_name | string | Имя аккаунта - владельца виртуальной сети |
|
||||
| computes | int | Кол-во вычислительных мощностей, использующих виртуальную сеть |
|
||||
| created_by | string | Информация о создателе виртуальной сети |
|
||||
| created_time | int | Время создания виртуальной сети |
|
||||
| deleted_by | string | Информация о том, кто удалил виртуальную сеть |
|
||||
| deleted_time | int | Время удаления виртуальной сети |
|
||||
| external_ip | string | Внешний IP - адрес |
|
||||
| vin_id | int | Идентификатор виртуальной сети |
|
||||
| vin_name | string | Название виртуальной сети |
|
||||
| network | string | Сеть |
|
||||
| pri_vnf_dev_id | int | ID для vnf - разработки |
|
||||
| rg_id | int | ID ресурсной группы |
|
||||
| rg_name | string | Название ресурсной группы |
|
||||
| status | string | Статус ресурсной группы |
|
||||
| updated_by | string | Кем была обновлена ресурсная группа |
|
||||
| updated_time | int | Время обновления |
|
||||
|
||||
|
||||
## Пример использования
|
||||
Пример вызова _data source_ функции **decort_account_vins_list**:
|
||||
```terraform
|
||||
data "decort_account_vins_list" "avl" {
|
||||
#id аккаунта
|
||||
#обязательный параметр
|
||||
#тип - число
|
||||
account_id = 11111
|
||||
|
||||
}
|
||||
# once the above directive completes, account vins list will be accessible
|
||||
# as data.decort_account_vins_list.avl.items
|
||||
```
|
||||
|
||||
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://github.com/rudecs/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)).
|
||||
|
||||
После успешного завершения такого вызова **decort_account_vins_list** в переменной `data.decort_account_vins_list.avl` будут сохранены возвращаемые значения.
|
||||
48
06.02.23-Data-функция-decort_account_list-получение-информации-о-всех-доступных-аккаунтах.md
Normal file
48
06.02.23-Data-функция-decort_account_list-получение-информации-о-всех-доступных-аккаунтах.md
Normal file
@@ -0,0 +1,48 @@
|
||||
Функция доступна в провайдере версии 2.3 и выше.
|
||||
|
||||
_Data source_ функция **decort_account_list** служит для получения информации о всех доступных аккаунтах.
|
||||
|
||||
## Аргументы
|
||||
_Data source_ функция **decort_account_list** принимает следующие аргументы:
|
||||
| Аргумент | Тип | Обязательный | Описание |
|
||||
| --- | --- | --- | --- |
|
||||
| page | int | :x: | Номер страниц |
|
||||
| size | int | :x: | Размер страницы |
|
||||
|
||||
|
||||
## Возвращаемые значения
|
||||
В случае успешного выполнения _data source_ функция **decort_account_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
| --- | --- | --- |
|
||||
| account_id | int | ID аккаунта |
|
||||
| account_name | string | Название аккаунта |
|
||||
| acl | []Struct{<br/>explicit bool<br/>guid string<br/>right string<br/>status string<br/>type string<br/>user_group_id string<br/>} | Более подробная информация об аккаунтах<br/>Явно ли указан доступ<br/>guid аккаунта<br/>Права доступа<br/>Статус аккаунта<br/>Тип аккаунта<br/>Идентификатор пользователя-владельца аккаунта<br/> <br/> |
|
||||
| created_time | int | Время создания аккаунта |
|
||||
| deleted_time | int | Время удаления аккаунта |
|
||||
| status | string | Статус аккаунта |
|
||||
| updated_time | int | Время последнего обновления |
|
||||
|
||||
## Пример использования
|
||||
Пример вызова _data source_ функции **decort_account_list**:
|
||||
```terraform
|
||||
data "decort_account_list" "al" {
|
||||
#номер страницы для отображения
|
||||
#опциональный параметр
|
||||
#тип - число
|
||||
#если не задан - выводятся все доступные данные
|
||||
#page = 2
|
||||
|
||||
#размер страницы
|
||||
#опциональный параметр
|
||||
#тип - число
|
||||
#если не задан - выводятся все доступные данные
|
||||
#size = 3
|
||||
}
|
||||
# once the above directive completes, account list will be accessible
|
||||
# as data.decort_account_list.al.items
|
||||
```
|
||||
|
||||
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://github.com/rudecs/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)).
|
||||
|
||||
После успешного завершения такого вызова **decort_account_list** в переменной `data.decort_account_list.al` будут сохранены возвращаемые значения.
|
||||
48
06.02.24-Data-функция-decort_account_deleted_list-получение-информации-об-удаленных-аккаунтах.md
Normal file
48
06.02.24-Data-функция-decort_account_deleted_list-получение-информации-об-удаленных-аккаунтах.md
Normal file
@@ -0,0 +1,48 @@
|
||||
Функция доступна в провайдере версии 2.3 и выше.
|
||||
|
||||
_Data source_ функция **decort_account_deleted_list** служит для получения информации об удаленных аккаунтах, которые можно восстановить в дальнейшем. В данный список попадают аккаунты, удаленные с флагом permanently, выставленным в false.
|
||||
|
||||
## Аргументы
|
||||
_Data source_ функция **decort_account_deleted_list** принимает следующие аргументы:
|
||||
| Аргумент | Тип | Обязательный | Описание |
|
||||
| --- | --- | --- | --- |
|
||||
| page | int | :x: | Номер страниц |
|
||||
| size | int | :x: | Размер страницы |
|
||||
|
||||
|
||||
## Возвращаемые значения
|
||||
В случае успешного выполнения _data source_ функция **decort_account_deleted_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
| --- | --- | --- |
|
||||
| account_id | int | ID аккаунта |
|
||||
| account_name | string | Название аккаунта |
|
||||
| acl | []Struct{<br/>explicit bool<br/>guid string<br/>right string<br/>status string<br/>type string<br/>user_group_id string<br/>} | Более подробная информация об аккаунтах<br/>Явно ли указан доступ<br/>guid аккаунта<br/>Права доступа<br/>Статус аккаунта<br/>Тип аккаунта<br/>Идентификатор пользователя-владельца аккаунта<br/> <br/> |
|
||||
| created_time | int | Время создания аккаунта |
|
||||
| deleted_time | int | Время удаления аккаунта |
|
||||
| status | string | Статус аккаунта |
|
||||
| updated_time | int | Время последнего обновления |
|
||||
|
||||
## Пример использования
|
||||
Пример вызова _data source_ функции **decort_account_deleted_list**:
|
||||
```terraform
|
||||
data "decort_account_deleted_list" "adl" {
|
||||
#номер страницы для отображения
|
||||
#опциональный параметр
|
||||
#тип - число
|
||||
#если не задан - выводятся все доступные данные
|
||||
#page = 2
|
||||
|
||||
#размер страницы
|
||||
#опциональный параметр
|
||||
#тип - число
|
||||
#если не задан - выводятся все доступные данные
|
||||
#size = 3
|
||||
}
|
||||
# once the above directive completes, account deleted list will be accessible
|
||||
# as data.decort_account_deleted_list.adl.items
|
||||
```
|
||||
|
||||
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://github.com/rudecs/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)).
|
||||
|
||||
После успешного завершения такого вызова **decort_account_deleted_list** в переменной `data.decort_account_deleted_list.adl` будут сохранены возвращаемые значения.
|
||||
@@ -0,0 +1,58 @@
|
||||
Функция доступна в провайдере версии 2.3 и выше.
|
||||
|
||||
_Data source_ функция **decort_account** служит для получения информации об аккаунте.
|
||||
|
||||
## Аргументы
|
||||
_Data source_ функция **decort_account** принимает следующие аргументы:
|
||||
| Аргумент | Тип | Обязательный | Описание |
|
||||
| --- | --- | --- | --- |
|
||||
| account_id | int | :heavy_check_mark: | ID аккаунте |
|
||||
|
||||
|
||||
## Возвращаемые значения
|
||||
В случае успешного выполнения _data source_ функция **decort_account** возвращает следующие параметры:
|
||||
|
||||
| Параметр | Тип | Описание |
|
||||
| --- | --- | --- |
|
||||
| account_id | int | ID аккаунта |
|
||||
| account_name | string | Название аккаунта |
|
||||
| meta | []string | Мета информация |
|
||||
| resources | Struct{<br/>current Struct{<br/>cpu int<br/>disksize int<br/>extips int<br/>exttraffic int<br/>gpu int<br/>ram int<br/>}<br/>reserved Struct{<br/>cpu int<br/>disksize int<br/>extips int<br/>exttraffic int<br/>gpu int<br/>ram int<br/>}<br/>} | Информация о ресурсах<br/>Задействованные<br/>Кол-вол ядер<br/>Размер диска, ГБ<br/>Кол-во внешних ip-адресов<br/>Размер внешнего траффика<br/>Кол-во графических ядер<br/>Размер RAM, MБ<br/><br/>Зарезервированные<br/>Кол-вол ядер<br/>Размер диска, ГБ<br/>Кол-во внешних ip-адресов<br/>Размер внешнего траффика<br/>Кол-во графических ядер<br/>Размер RAM, MБ<br/><br/> <br/> |
|
||||
| acl | []Struct{<br/>can_be_deleted bool<br/>explicit bool<br/>guid string<br/>right string<br/>status string<br/>type string<br/>user_group_id string<br/>} | Более подробная информация об аккаунтах<br/>Может ли быть удален аккаунт<br/>Явно ли указан доступ<br/>guid аккаунта<br/>Права доступа<br/>Статус аккаунта<br/>Тип аккаунта<br/>Идентификатор пользователя-владельца аккаунта<br/> <br/> |
|
||||
| company | string | Название компании, которой принадлежит аккаунт |
|
||||
| companyurl | string | url-адрес компани |
|
||||
| created_by | string | Пользователь - создателя аккаунта |
|
||||
| created_time | int | Время создания аккаунта |
|
||||
| deactivation_time | float | Время деактивации аккаунта |
|
||||
| deleted_by | string | Пользователь, удаливший аккаунт |
|
||||
| deleted_time | int | Время удаления аккаунта |
|
||||
| displayname | string | Отображаемое имя аккаунта |
|
||||
| guid | int | Внутренний guid аккаунта |
|
||||
| resource_limits | Struct{<br/>cu_c float<br/>cu_d float<br/>cu_i float<br/>cu_m float<br/>cu_np float<br/>gpu_units float<br/>} | Ограничения ресурсов<br/>Кол-во ядер<br/>Размер диска, ГБ<br/>Число публичных ip адресов<br/>Размер RAM, МБ<br/>Объем трафика, ГБ<br/>Кол-вол графических ядер<br/> <br/> |
|
||||
| send_access_emails | bool | Флаг, отправлять ли на указанную почту письмо о доступе |
|
||||
| service_account | bool | Флаг, является ли аккаунт аккаунтом-обслуживания |
|
||||
| status | string | Статус аккаунта |
|
||||
| updated_time | int | Время последнего обновления |
|
||||
| version | int | Версия аккаунта |
|
||||
| vins | []int | Список id виртуальных сетей |
|
||||
| vinses | []int | Список id виртуальных сетей |
|
||||
| computes | Struct{<br/>started int<br/>stopped int <br/>} | Информация о вычислительных мощностях<br/>Кол-во запущенных<br/>Кол-во остановленных<br/> <br/> |
|
||||
| machines | Struct{<br/>halted int<br/>running int <br/>} | Информация о виртуальных машинах (устаревшее)<br/>Кол-во запущенных<br/>Кол-во остановленных<br/> <br/> |
|
||||
|
||||
## Пример использования
|
||||
Пример вызова _data source_ функции **decort_account**:
|
||||
```terraform
|
||||
data "decort_account" "a" {
|
||||
#id аккаунта
|
||||
#обязательный параметр
|
||||
#тип - число
|
||||
account_id = 28096
|
||||
|
||||
}
|
||||
# once the above directive completes, account will be accessible
|
||||
# as data.decort_account.a
|
||||
```
|
||||
|
||||
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://github.com/rudecs/terraform-provider-decort/wiki/05.-%D0%98%D0%BD%D0%B8%D1%86%D0%B8%D0%B0%D0%BB%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F-Terraform-%D0%BF%D1%80%D0%BE%D0%B2%D0%B0%D0%B9%D0%B4%D0%B5%D1%80%D0%B0-DECORT.)).
|
||||
|
||||
После успешного завершения такого вызова **decort_account** в переменной `data.decort_account.a` будут сохранены возвращаемые значения.
|
||||
Reference in New Issue
Block a user