Create resource decort_pcidevice page

stSolo
2022-05-05 10:28:59 +03:00
parent e29e6ba961
commit 918cf03981

@@ -0,0 +1,58 @@
Функция доступна в провайдере версии 2.2 и выше.
**Внимание:** необходимы права администратора.
_Resource_ функция **decort_pcidevice** служит для управления устройств с шиной PCI.
## Аргументы
_Resource_ функция **decort_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, при наличии ресурса в облаке |
## Возвращаемые значения
В случае успешного выполнения _resource_ функция **decort_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 | Системное имя устройства |
## Пример использования
Пример вызова _resource_ функции **decort_pcidevice**:
```terraform
resource "decort_pcidevice" "pd" {
name = "test_device"
hw_path = "0000:01:00.0"
description = "test desc"
rg_id = 11111
stack_id = 11
#enable = false
#force = true
}
# once the above directive completes, pcidevice will be accessible
# as decort_pcidevice.pd
```
Данный пример подразумевает, что ранее по тексту 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_pcidevice** в переменной `decort_pcidevice.pd` будут сохранены возвращаемые значения.