BASIS/terraform-provider-decort
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 62 Wiki Activity

update data: pcidevice, pcidevice_list; resource: pcidevice

loskutovanl
2023-11-22 12:19:14 +03:00
parent a29d316f8c
commit 15c3fc3ee2
3 changed files with 76 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
06.02.11-Data-функция-decort_pcidevice_list-получение-информации-о-всех-pcidevice.md

@@ -1,37 +1,50 @@
Функция доступна в провайдере версии 2.2 и выше.
_Data source_ функция **decort_pcidevice_list** служит для получения информации об имеющихся устройств с шиной PCI.
_Data source_ функция **decort_cb_pcidevice_list** служит для получения информации об имеющихся устройств с шиной PCI.
## Аргументы
_Data source_ функция **decort_pcidevice_list** не принимает аргументов.
_Data source_ функция **decort_cb_pcidevice_list** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
|------------|--------|--------------|-----------------------------------|
| by_id | int | :x: | фильтр по ID устройства |
| compute_id | int | :x: | фильм по ID вычислительной машины |
| name | string | :x: | фильтр по наименованию устройства |
| rg_id | int | :x: | фильтр по ID ресурсной группы |
| status | string | :x: | фильтр по статусу устройства |
| page | int | :x: | Номер страницы для вывода |
| size | int | :x: | Размер страницы для вывода |
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_pcidevice_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
В случае успешного выполнения _data source_ функция **decort_cb_pcidevice_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров:
| Параметр | Тип | Описание |
| --- | --- | --- |
| meta | []string | Мета информация |
| compute_id | int | id вычислительной площадки |
| description | string | Описание |
| guid | int | Внутренний id |
| hw_path | string | HW Путь |
| device_id | int | id устройства |
| name | string | Наименование устройства |
| rg_id | int | id ресурсной группы (resource group) |
| stack_id | int | id стэка |
| status | string | Статус устройства |
| system_name | string | Системное имя устройства |
| Параметр | Тип | Описание |
|-------------|----------|--------------------------------------|
| ckey | string | CKey |
| meta | []string | Мета информация |
| compute_id | int | id вычислительной площадки |
| description | string | Описание |
| guid | int | Внутренний id |
| hw_path | string | HW Путь |
| device_id | int | id устройства |
| name | string | Наименование устройства |
| rg_id | int | id ресурсной группы (resource group) |
| stack_id | int | id стэка |
| status | string | Статус устройства |
| system_name | string | Системное имя устройства |
## Пример использования
Пример вызова _data source_ функции **decort_pcidevice_list**:
Пример вызова _data source_ функции **decort_cb_pcidevice_list**:
```terraform
data "decort_pcidevice_list" "pl" {
data "decort_cb_pcidevice_list" "pl" {
}
# once the above directive completes, pcidevice list will be accessible
# as data.decort_pcidevice_list.pl.items
# as data.decort_cb_pcidevice_list.pl.items
```
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/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_pcidevice_list** в переменной `data.decort_pcidevice_list.pl` будут сохранены возвращаемые значения.
После успешного завершения такого вызова **decort_cb_pcidevice_list** в переменной `data.decort_cb_pcidevice_list.pl` будут сохранены возвращаемые значения.

41
06.02.12-Data-функция-decort_pcidevice-получение-информации-о-pcidevice.md

@@ -1,42 +1,43 @@
Функция доступна в провайдере версии 2.2 и выше.
_Data source_ функция **decort_pcidevice** служит для получения информации об имеющихся устройств с шиной PCI.
_Data source_ функция **decort_cb_pcidevice** служит для получения информации об имеющихся устройств с шиной PCI.
## Аргументы
_Data source_ функция **decort_pcidevice** принимает следующие аргументы:
_Data source_ функция **decort_cb_pcidevice** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| --- | --- | --- | --- |
| device_id | int | :heavy_check_mark: | ID устройства |
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_pcidevice** возвращает в указанную при вызове переменную элемент, который состоит из следующих параметров:
В случае успешного выполнения _data source_ функция **decort_cb_pcidevice** возвращает в указанную при вызове переменную элемент, который состоит из следующих параметров:
| Параметр | Тип | Описание |
| --- | --- | --- |
| meta | []string | Мета информация |
| compute_id | int | id вычислительной площадки |
| description | string | Описание |
| guid | int | Внутренний id |
| hw_path | string | HW Путь |
| device_id | int | id устройства |
| name | string | Наименование устройства |
| rg_id | int | id ресурсной группы (resource group) |
| stack_id | int | id стэка |
| status | string | Статус устройства |
| system_name | string | Системное имя устройства |
| Параметр | Тип | Описание |
|-------------|----------|--------------------------------------|
| ckey | string | CKey |
| meta | []string | Мета информация |
| compute_id | int | id вычислительной площадки |
| description | string | Описание |
| guid | int | Внутренний id |
| hw_path | string | HW Путь |
| device_id | int | id устройства |
| name | string | Наименование устройства |
| rg_id | int | id ресурсной группы (resource group) |
| stack_id | int | id стэка |
| status | string | Статус устройства |
| system_name | string | Системное имя устройства |
## Пример использования
Пример вызова _data source_ функции **decort_pcidevice**:
Пример вызова _data source_ функции **decort_cb_pcidevice**:
```terraform
data "decort_pcidevice" "pd" {
data "decort_cb_pcidevice" "pd" {
device_id = 111
}
# once the above directive completes, pcidevice will be accessible
# as data.decort_pcidevice.pd
# as data.decort_cb_pcidevice.pd
```
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/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_pcidevice** в переменной `data.decort_pcidevice.pd` будут сохранены возвращаемые значения.
После успешного завершения такого вызова **decort_cb_pcidevice** в переменной `data.decort_cb_pcidevice.pd` будут сохранены возвращаемые значения.

41
07.02.01-Resource-функция-decort_pcidevice-управление-устройством.md

@@ -1,28 +1,30 @@
Функция доступна в провайдере версии 2.2 и выше.
_Resource_ функция **decort_pcidevice** служит для управления устройств с шиной PCI.
_Resource_ функция **decort_cb_pcidevice** служит для управления устройств с шиной PCI.
## Аргументы
_Resource_ функция **decort_pcidevice** принимает следующие аргументы:
_Resource_ функция **decort_cb_pcidevice** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
| ----------- | ------ | ------------------ | ---------------------------------------------------------------------------------------------- |
| name | string | :heavy_check_mark: | Имя устройства |
| hw_path | string | :heavy_check_mark: | Путь до устройства (HW Path) |
| description | string | :heavy_check_mark: | Описание устройства |
| rg_id | int | :heavy_check_mark: | id ресурсной группы устройства |
| stack_id | int | :heavy_check_mark: | id стака устройства |
| enable | bool | :x: | Доступность устройства, может использоваться на уже созданном ресурсе |
| force | bool | :x: | Принудительное удаление устройства, используется при удалении устройства |
| device_id | int | :x: | id устройства, может быть использовано для формирования .tfstate, при наличии ресурса в облаке |
| Аргумент | Тип | Обязательный | Описание |
|---------------|--------|--------------------|------------------------------------------------------------------------------------------------|
| name | string | :heavy_check_mark: | Имя устройства |
| hw_path | string | :heavy_check_mark: | Путь до устройства (HW Path) |
| rg_id | int | :heavy_check_mark: | id ресурсной группы устройства |
| stack_id | int | :heavy_check_mark: | id стака устройства |
| description | string | :x: | Описание устройства |
| enable | bool | :x: | Доступность устройства, может использоваться на уже созданном ресурсе |
| force_disable | bool | :x: | Принудительное отключение устройства, используется при отключении устройства |
| force_delete | bool | :x: | Принудительное удаление устройства, используется при удалении устройства |
| device_id | int | :x: | id устройства, может быть использовано для формирования .tfstate, при наличии ресурса в облаке |
## Возвращаемые значения
В случае успешного выполнения _resource_ функция **decort_pcidevice** возвращает в указанную при вызове переменную элемент, который состоит из следующих параметров:
В случае успешного выполнения _resource_ функция **decort_cb_pcidevice** возвращает в указанную при вызове переменную элемент, который состоит из следующих параметров:
| Параметр | Тип | Описание |
| ----------- | -------- | ------------------------------------ |
|-------------|----------|--------------------------------------|
| ckey | string | CKey |
| meta | []string | Мета информация |
| compute_id | int | id вычислительной площадки |
| description | string | Описание |
@@ -37,10 +39,10 @@ _Resource_ функция **decort_pcidevice** принимает следующ
## Пример использования
Пример вызова _resource_ функции **decort_pcidevice**:
Пример вызова _resource_ функции **decort_cb_pcidevice**:
```terraform
resource "decort_pcidevice" "pd" {
resource "decort_cb_pcidevice" "pd" {
name = "test_device"
hw_path = "0000:01:00.0"
description = "test desc"
@@ -48,12 +50,13 @@ resource "decort_pcidevice" "pd" {
stack_id = 11
#enable = false
#force = true
#force_disable = true
#force_delete = true
}
# once the above directive completes, pcidevice will be accessible
# as decort_pcidevice.pd
# as decort_cb_pcidevice.pd
```
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT)).
После успешного завершения такого вызова **decort_pcidevice** в переменной `decort_pcidevice.pd` будут сохранены возвращаемые значения.
После успешного завершения такого вызова **decort_cb_pcidevice** в переменной `decort_cb_pcidevice.pd` будут сохранены возвращаемые значения.