Create resource decort_pfw, add a description

stSolo
2022-03-29 11:13:34 +03:00
parent 0ed3900426
commit 535cd46312

@@ -0,0 +1,37 @@
_Resource_ функция **decort_pfw** служит для управления правилами трансляции сетевых портов для виртуальных серверов.
## Аргументы
_Resource_ функция **decort_pfw** для создания ресурса принимает следующие аргументы:
| Аргумент | Тип | Описание |
| --- | --- | --- |
| proto | string | Обязательный параметр,<br/>сетевой протокол<br/>возможные значения: "tcp", "udp" |
| local_base_port | int | Обязательный параметр,<br/>номер внутреннего базового порта<br/>возможные значения:<br/>целые числа от 1 до 65535 |
| compute_id | int | Обязательный параметр,<br/>ID compute экземпляра. |
| public_port_start | int | Обязательный параметр,<br/> Внешний начальный номер порта для правила (начало диапазона).<br/>возможные значения:<br/>целые числа от 1 до 65535 |
| public_port_end | int | Опциональный параметр,<br/> Внешний конечный номер порта для правила (конец диапазона).<br/>возможные значения:<br/>целые числа от 1 до 65535 |
## Возвращаемые значения
| Аргумент | Тип | Описание |
| --- | --- | --- |
| local_ip | string | IP адрес вычислительного (compute) экземпляра |
## Пример использования
Пример вызова _resource_ функции **decort_pfw**:
```terraform
resource "decort_pfw" "my_pfw" {
proto = "tcp"
local_base_port = 1111
compute_id = 123
public_port_start = 2000
#public_port_end = 3000
}
# once the above directive completes, pfw will be accessible
# as decort_pfw.my_pfw
```
Данный пример подразумевает, что ранее по тексту 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_pfw** в переменной `decort_pfw.my_pfw` будут сохранены возвращаемые значения. Получить ip адрес можно, обратившись к переменной как: `decort_pfw.my_pfw.local_ip`