diff --git a/06.02.04-Data-функция-decort_cb_vins-получение-информации-о-ViNS.md b/06.02.04-Data-функция-decort_cb_vins-получение-информации-о-ViNS.md index ebc533d..6b6e8b2 100644 --- a/06.02.04-Data-функция-decort_cb_vins-получение-информации-о-ViNS.md +++ b/06.02.04-Data-функция-decort_cb_vins-получение-информации-о-ViNS.md @@ -13,39 +13,39 @@ _Data source_ функция **decort_cb_vins** принимает следую ## Возвращаемые значения В случае успешного выполнения _data source_ функция **decort_cb_vins** возвращает в указанную при вызове переменную следующие значения: -| Параметр | Тип | Описание | -|----------------------|------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------| -| vins_id | int | id vins | -| vnf_dev | []Struct [см. ниже](#описание-структуры-vnf_dev) | Виртуальный маршрутизатор внутренней сети | -| account_id | int | ID подписчика ("account"), которому принадлежит ViNS. | -| account_name | string | Имя подписчика ("account"), которому принадлежит ViNS. | -| created_by | string | Аккаунт, создавший vins | -| created_time | int | Время создания vins | -| default_gw | string | Шлюз по умолчанию | -| default_qos | []Struct [см. ниже](#описание-структуры-default_qos) | QOS по умолчанию | -| deleted_by | string | Пользователь, удаливший vins | -| deleted_time | int | Время удаления vins | -| description | string | Текстовое описание ViNS. | -| gid | int | GRID ID | -| guid | int | ID ресурса | -| lock_status | string | Статус доступности | -| manager_id | int | Manager id | -| manager_type | string | Type of manager | -| milestones | int | Вехи | -| name | string | Имя ViNS. | -| netmask | int | Маска сети | -| network | string | Информация о сети | -| pre_reservations_num | int | Кол-во зарезервированных ip адресов | -| redundant | bool | Redudant | -| rg_id | int | Идентификатор ресурсной группы, на уровне которой создан ViNS. Для ViNS, существующих на уровне "account", данный параметр будет равен 0. | -| rg_name | string | Имя ресурсной группы | -| sec_vnf_dev_id | int | ID sec внутренней сети для разработки | -| status | string | Статус vins | -| updated_by | string | Кем был обновлен vins | -| updated_time | int | Время последнего обновления vins | -| user_managed | bool | Флаг, управляется ли пользователем | -| vnfs | []Struct [см. ниже](#описание-структуры-vnfs) | Список VNFs | -| vxlan_id | int | Идентификатор vxlan | +| Параметр | Тип | Описание | +|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| vins_id | int | id vins | +| vnf_dev | []Struct [см. ниже](#описание-структуры-vnf_dev) | Виртуальный маршрутизатор внутренней сети | +| account_id | int | ID подписчика ("account"), которому принадлежит ViNS. | +| account_name | string | Имя подписчика ("account"), которому принадлежит ViNS. | +| created_by | string | Аккаунт, создавший vins | +| created_time | int | Время создания vins | +| default_gw | string | Шлюз по умолчанию | +| default_qos | Struct [см. ниже](#описание-структуры-default_qos) | QOS по умолчанию | +| deleted_by | string | Пользователь, удаливший vins | +| deleted_time | int | Время удаления vins | +| description | string | Текстовое описание ViNS. | +| gid | int | GRID ID | +| guid | int | ID ресурса | +| lock_status | string | Статус доступности | +| manager_id | int | Manager id | +| manager_type | string | Type of manager | +| milestones | int | Вехи | +| name | string | Имя ViNS. | +| netmask | int | Маска сети | +| network | string | Информация о сети | +| pre_reservations_num | int | Кол-во зарезервированных ip адресов | +| redundant | bool | Redudant | +| rg_id | int | Идентификатор ресурсной группы, на уровне которой создан ViNS. Для ViNS, существующих на уровне "account", данный параметр будет равен 0. | +| rg_name | string | Имя ресурсной группы | +| sec_vnf_dev_id | int | ID sec внутренней сети для разработки | +| status | string | Статус vins | +| updated_by | string | Кем был обновлен vins | +| updated_time | int | Время последнего обновления vins | +| user_managed | bool | Флаг, управляется ли пользователем | +| vnfs | []Struct [см. ниже](#описание-структуры-vnfs) | Список VNFs | +| vxlan_id | int | Идентификатор vxlan | ### Описание структуры vnf_dev | Параметр | Тип | Описание | diff --git a/06.02.06-Data-функция-decort_cb_image_list-получение-информации-об-образах.md b/06.02.06-Data-функция-decort_cb_image_list-получение-информации-об-образах.md index 13654dd..308aa17 100644 --- a/06.02.06-Data-функция-decort_cb_image_list-получение-информации-об-образах.md +++ b/06.02.06-Data-функция-decort_cb_image_list-получение-информации-об-образах.md @@ -45,7 +45,7 @@ _Data source_ функция **decort_cb_image_list** принимает сле | enabled | bool | Доступность образа | | gid | int | ID платформы, где образ будет создан | | guid | int | Внутренний id образа, совпадает с image_id | -| history | object{id: int, guid: string, timestamp: int} | История обновлений образа | +| history | []Struct [см. ниже](#описание-структуры-history) | История обновлений образа | | hot_resize | bool | Использует ли машина горячее изменение размера образа | | image_id | int | ID образа | | last_modified | int | Дата последнего изменения | @@ -83,6 +83,13 @@ _Data source_ функция **decort_cb_image_list** принимает сле | type | string | Тип ресурса | | user_group_id | string | ID user group | +### Описание структуры history +| Параметр | Тип | Описание | +|-----------|--------|--------------------------------| +| id | int | id записи об обновлении образа | +| guid | string | guid ресурса | +| timestamp | int | временная метка | + ## Пример использования Пример вызова _data source_ функции **decort_cb_image_list**: ```terraform diff --git a/06.02.07-Data-функция-decort_cb_image-получение-информации-об-образе.md b/06.02.07-Data-функция-decort_cb_image-получение-информации-об-образе.md index f5c6c93..b28d20b 100644 --- a/06.02.07-Data-функция-decort_cb_image-получение-информации-об-образе.md +++ b/06.02.07-Data-функция-decort_cb_image-получение-информации-об-образе.md @@ -18,48 +18,48 @@ ID необходимого образа можно взять вызвав [dec ## Возвращаемые значения В случае успешного выполнения _data source_ функция **decort_cb_image** возвращает в указанную при вызове переменную следующие значения: -| Параметр | Тип | Описание | -| --- |-----------------------------------------------|----------------------------------------------------------| -| ckey | string | CKey | -| meta | []string | Мета информация об образе | -| account_id | int | accountId привязки образа | -| acl | []Struct [см. ниже](#описание-структуры-acl) | Cписок Acces Control | -| architecture | string | Архитектура образа, возможен вариант X86_64 или PPC64_LE | -| boot_type | string | Тип запуска ОС - bios или uefi | -| bootable | bool | Является ли образ загрузочным | -| computeci_id | int | ID вычислительного ресурса | -| deleted_time | int | Время удаления | -| desc | string | Описание образа | -| drivers | []string | Список используемых драйверов | -| enabled | bool | Доступность образа | -| gid | int | ID платформы, где образ будет создан | -| guid | int | Внутренний id образа, совпадает с image_id | -| history | object{id: int, guid: string, timestamp: int} | История обновлений образа | -| hot_resize | bool | Использует ли машина горячее изменение размера образа | -| image_id | int | ID образа | -| last_modified | int | Дата последнего изменения | -| link_to | int | Привязка к образу, используется в виртуальных образах | -| milestones | int | Вехи | -| name | string | Название образа | -| password | string | Пароль для образа | -| pool_name | string | Пул, в котором был создан образ | -| present_to | []int | Список ID ресурсов для который предоставлен образ | -| 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 | -| shared_with | []int | Список ресурсов, имеющих доступ к образу | -| size | int | Размер образа | -| status | string | Статус образа | -| tech_status | string | Технический статус | -| image_type | string | Тип образа: linux, windows или другой | -| unc_path | string | unc path | -| url | string | Адрес, которого осуществлялась загрузка образа | -| username | string | Имя пользователя образа | -| version | string | Версия | +| Параметр | Тип | Описание | +| --- |--------------------------------------------------|----------------------------------------------------------| +| ckey | string | CKey | +| meta | []string | Мета информация об образе | +| account_id | int | accountId привязки образа | +| acl | []Struct [см. ниже](#описание-структуры-acl) | Cписок Acces Control | +| architecture | string | Архитектура образа, возможен вариант X86_64 или PPC64_LE | +| boot_type | string | Тип запуска ОС - bios или uefi | +| bootable | bool | Является ли образ загрузочным | +| computeci_id | int | ID вычислительного ресурса | +| deleted_time | int | Время удаления | +| desc | string | Описание образа | +| drivers | []string | Список используемых драйверов | +| enabled | bool | Доступность образа | +| gid | int | ID платформы, где образ будет создан | +| guid | int | Внутренний id образа, совпадает с image_id | +| history | []Struct [см. ниже](#описание-структуры-history) | История обновлений образа | +| hot_resize | bool | Использует ли машина горячее изменение размера образа | +| image_id | int | ID образа | +| last_modified | int | Дата последнего изменения | +| link_to | int | Привязка к образу, используется в виртуальных образах | +| milestones | int | Вехи | +| name | string | Название образа | +| password | string | Пароль для образа | +| pool_name | string | Пул, в котором был создан образ | +| present_to | []int | Список ID ресурсов для который предоставлен образ | +| 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 | +| shared_with | []int | Список ресурсов, имеющих доступ к образу | +| size | int | Размер образа | +| status | string | Статус образа | +| tech_status | string | Технический статус | +| image_type | string | Тип образа: linux, windows или другой | +| unc_path | string | unc path | +| url | string | Адрес, которого осуществлялась загрузка образа | +| username | string | Имя пользователя образа | +| version | string | Версия | ### Описание структуры acl | Параметр | Тип | Описание | @@ -71,6 +71,13 @@ ID необходимого образа можно взять вызвав [dec | type | string | Тип ресурса | | user_group_id | string | ID user group | +### Описание структуры history +| Параметр | Тип | Описание | +|-----------|--------|--------------------------------| +| id | int | id записи об обновлении образа | +| guid | string | guid ресурса | +| timestamp | int | временная метка | + ## Пример использования Пример вызова _data source_ функции **decort_cb_image**: ```terraform diff --git a/06.02.08-Data-функция-decort_cb_image_list_stacks-получение-информации-о-доступных-для-образа-stacks.md b/06.02.08-Data-функция-decort_cb_image_list_stacks-получение-информации-о-доступных-для-образа-stacks.md index 51b7017..0b9b31e 100644 --- a/06.02.08-Data-функция-decort_cb_image_list_stacks-получение-информации-о-доступных-для-образа-stacks.md +++ b/06.02.08-Data-функция-decort_cb_image_list_stacks-получение-информации-о-доступных-для-образа-stacks.md @@ -44,15 +44,15 @@ _Data source_ функция **decort_cb_image_list_stacks** принимает | type | string | Тип stack | ### Описание структуры packages -| Параметр | Тип | Описание | -|--------------------|-------------------------------------------------------------|----------------------------------------| -| libvirt_bin | []Struct [см. ниже](#описание-структуры-libvirt_bin) | Информация о пакете libvirt_bin | -| libvirt_daemon | []Struct [см. ниже](#описание-структуры-libvirt_daemon) | Информация о пакете libvirt_daemon | -| lvm2_lockd | []Struct [см. ниже](#описание-структуры-lvm2_lockd) | Информация о пакете lvm2_lockd | -| openvswitch_common | []Struct [см. ниже](#описание-структуры-openvswitch_common) | Информация о пакете openvswitch_common | -| openvswitch_switch | []Struct [см. ниже](#описание-структуры-openvswitch_switch) | Информация о пакете openvswitch_switch | -| qemu_system_x86 | []Struct [см. ниже](#описание-структуры-qemu_system_x86) | Информация о пакете qemu_system_x86 | -| sanlock | []Struct [см. ниже](#описание-структуры-sanlock) | Информация о пакете sanlock | +| Параметр | Тип | Описание | +|--------------------|-----------------------------------------------------|----------------------------------------| +| libvirt_bin | Struct [см. ниже](#описание-структуры-libvirt_bin) | Информация о пакете libvirt_bin | +| libvirt_daemon | Struct [см. ниже](#описание-структуры-libvirt_daemon) | Информация о пакете libvirt_daemon | +| lvm2_lockd | Struct [см. ниже](#описание-структуры-lvm2_lockd) | Информация о пакете lvm2_lockd | +| openvswitch_common | Struct [см. ниже](#описание-структуры-openvswitch_common) | Информация о пакете openvswitch_common | +| openvswitch_switch | Struct [см. ниже](#описание-структуры-openvswitch_switch) | Информация о пакете openvswitch_switch | +| qemu_system_x86 | Struct [см. ниже](#описание-структуры-qemu_system_x86) | Информация о пакете qemu_system_x86 | +| sanlock | Struct [см. ниже](#описание-структуры-sanlock) | Информация о пакете sanlock | ### Описание структуры libvirt_bin | Параметр | Тип | Описание | diff --git a/06.02.16-Data-функция-decort_cb_vins_list-получение-информации-о-всех-виртуальных-сетях.md b/06.02.16-Data-функция-decort_cb_vins_list-получение-информации-о-всех-виртуальных-сетях.md index f9a13d4..60bfaec 100644 --- a/06.02.16-Data-функция-decort_cb_vins_list-получение-информации-о-всех-виртуальных-сетях.md +++ b/06.02.16-Data-функция-decort_cb_vins_list-получение-информации-о-всех-виртуальных-сетях.md @@ -19,40 +19,40 @@ _Data source_ функция **decort_cb_vins_list** принимает след ## Возвращаемые значения В случае успешного выполнения _data source_ функция **decort_cb_vins_list** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров: -| Параметр | Тип | Описание | -|----------------------|------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------| -| vins_id | int | id vins | -| account_id | int | ID подписчика ("account"), которому принадлежит ViNS. | -| account_name | string | Имя подписчика ("account"), которому принадлежит ViNS. | -| created_by | string | Аккаунт, создавший vins | -| created_time | int | Время создания vins | -| default_gw | string | Шлюз по умолчанию | -| default_qos | []Struct [см. ниже](#описание-структуры-default_qos) | QOS по умолчанию | -| deleted_by | string | Пользователь, удаливший vins | -| deleted_time | int | Время удаления vins | -| description | string | Текстовое описание ViNS. | +| Параметр | Тип | Описание | +|----------------------|--------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| vins_id | int | id vins | +| account_id | int | ID подписчика ("account"), которому принадлежит ViNS. | +| account_name | string | Имя подписчика ("account"), которому принадлежит ViNS. | +| created_by | string | Аккаунт, создавший vins | +| created_time | int | Время создания vins | +| default_gw | string | Шлюз по умолчанию | +| default_qos | Struct [см. ниже](#описание-структуры-default_qos) | QOS по умолчанию | +| deleted_by | string | Пользователь, удаливший vins | +| deleted_time | int | Время удаления vins | +| description | string | Текстовое описание ViNS. | | external_ip | string | Внешний ip - адрес | -| gid | int | GRID ID | -| guid | int | ID ресурса | -| lock_status | string | Статус доступности | -| manager_id | int | Manager id | -| manager_type | string | Type of manager | -| milestones | int | Вехи | -| name | string | Имя ViNS. | -| netmask | int | Маска сети | -| network | string | Информация о сети | -| pre_reservations_num | int | Кол-во зарезервированных ip адресов | +| gid | int | GRID ID | +| guid | int | ID ресурса | +| lock_status | string | Статус доступности | +| manager_id | int | Manager id | +| manager_type | string | Type of manager | +| milestones | int | Вехи | +| name | string | Имя ViNS. | +| netmask | int | Маска сети | +| network | string | Информация о сети | +| pre_reservations_num | int | Кол-во зарезервированных ip адресов | | pri_vnf_dev_id | int | ID внутренней сети для разработки | -| redundant | bool | Redudant | -| rg_id | int | Идентификатор ресурсной группы, на уровне которой создан ViNS. Для ViNS, существующих на уровне "account", данный параметр будет равен 0. | -| rg_name | string | Имя ресурсной группы | -| sec_vnf_dev_id | int | ID sec внутренней сети для разработки | -| status | string | Статус vins | -| updated_by | string | Кем был обновлен vins | -| updated_time | int | Время последнего обновления vins | -| user_managed | bool | Флаг, управляется ли пользователем | -| vnfs | []Struct [см. ниже](#описание-структуры-vnfs) | Список VNFs | -| vxlan_id | int | Идентификатор vxlan | +| redundant | bool | Redudant | +| rg_id | int | Идентификатор ресурсной группы, на уровне которой создан ViNS. Для ViNS, существующих на уровне "account", данный параметр будет равен 0. | +| rg_name | string | Имя ресурсной группы | +| sec_vnf_dev_id | int | ID sec внутренней сети для разработки | +| status | string | Статус vins | +| updated_by | string | Кем был обновлен vins | +| updated_time | int | Время последнего обновления vins | +| user_managed | bool | Флаг, управляется ли пользователем | +| vnfs | Struct [см. ниже](#описание-структуры-vnfs) | Список VNFs | +| vxlan_id | int | Идентификатор vxlan | ### Описание структуры default_qos | Параметр | Тип | Описание | diff --git a/06.02.31-Data-функция-decort_cb_extnet-получение-информации-о-внешней-сети.md b/06.02.31-Data-функция-decort_cb_extnet-получение-информации-о-внешней-сети.md index 8355c0a..94a7f4c 100644 --- a/06.02.31-Data-функция-decort_cb_extnet-получение-информации-о-внешней-сети.md +++ b/06.02.31-Data-функция-decort_cb_extnet-получение-информации-о-внешней-сети.md @@ -17,7 +17,7 @@ _Data source_ функция **decort_cb_extnet** принимает следу | ckey | string | CKey | | meta | []string | Meta информация | | default | bool | Является ли внешняя сеть дефолтной | -| default_qos | []Struct{} [см.ниже](#описание-блока-default_qos) | Стандартные значения QOS | +| default_qos | Struct{} [см.ниже](#описание-блока-default_qos) | Стандартные значения QOS | | desc | string | Описание внешней сети | | free_ips | int | Кол-во свободных IP адресов | | guid | int | ID внешней сети на платформе | diff --git a/06.02.32-Data-функция-decort_cb_extnet_list-получение-информации-о-внешних-сетях.md b/06.02.32-Data-функция-decort_cb_extnet_list-получение-информации-о-внешних-сетях.md index 2a24055..101ace1 100644 --- a/06.02.32-Data-функция-decort_cb_extnet_list-получение-информации-о-внешних-сетях.md +++ b/06.02.32-Data-функция-decort_cb_extnet_list-получение-информации-о-внешних-сетях.md @@ -25,7 +25,7 @@ _Data source_ функция **decort_cb_extnet_list** принимает сле | ckey | string | CKey | | meta | []string | Meta информация | | default | bool | Является ли внешняя сеть дефолтной | -| default_qos | []Struct{} [см.ниже](#описание-блока-default_qos) | Стандартные значения QOS | +| default_qos | Struct{} [см.ниже](#описание-блока-default_qos) | Стандартные значения QOS | | desc | string | Описание внешней сети | | free_ips | int | Кол-во свободных IP адресов | | guid | int | ID внешней сети на платформе | diff --git a/06.02.33-Data-функция-decort_cb_stack-получение-информации-о-stack.md b/06.02.33-Data-функция-decort_cb_stack-получение-информации-о-stack.md index eb81922..f0cf297 100644 --- a/06.02.33-Data-функция-decort_cb_stack-получение-информации-о-stack.md +++ b/06.02.33-Data-функция-decort_cb_stack-получение-информации-о-stack.md @@ -41,15 +41,15 @@ _Data source_ функция **decort_cb_stack** принимает следую | type | string | Тип stack | ### Описание структуры packages -| Параметр | Тип | Описание | -|--------------------|-------------------------------------------------------------|----------------------------------------| -| libvirt_bin | []Struct [см. ниже](#описание-структуры-libvirt_bin) | Информация о пакете libvirt_bin | -| libvirt_daemon | []Struct [см. ниже](#описание-структуры-libvirt_daemon) | Информация о пакете libvirt_daemon | -| lvm2_lockd | []Struct [см. ниже](#описание-структуры-lvm2_lockd) | Информация о пакете lvm2_lockd | -| openvswitch_common | []Struct [см. ниже](#описание-структуры-openvswitch_common) | Информация о пакете openvswitch_common | -| openvswitch_switch | []Struct [см. ниже](#описание-структуры-openvswitch_switch) | Информация о пакете openvswitch_switch | -| qemu_system_x86 | []Struct [см. ниже](#описание-структуры-qemu_system_x86) | Информация о пакете qemu_system_x86 | -| sanlock | []Struct [см. ниже](#описание-структуры-sanlock) | Информация о пакете sanlock | +| Параметр | Тип | Описание | +|--------------------|-----------------------------------------------------|----------------------------------------| +| libvirt_bin | Struct [см. ниже](#описание-структуры-libvirt_bin) | Информация о пакете libvirt_bin | +| libvirt_daemon | Struct [см. ниже](#описание-структуры-libvirt_daemon) | Информация о пакете libvirt_daemon | +| lvm2_lockd | Struct [см. ниже](#описание-структуры-lvm2_lockd) | Информация о пакете lvm2_lockd | +| openvswitch_common | Struct [см. ниже](#описание-структуры-openvswitch_common) | Информация о пакете openvswitch_common | +| openvswitch_switch | Struct [см. ниже](#описание-структуры-openvswitch_switch) | Информация о пакете openvswitch_switch | +| qemu_system_x86 | Struct [см. ниже](#описание-структуры-qemu_system_x86) | Информация о пакете qemu_system_x86 | +| sanlock | Struct [см. ниже](#описание-структуры-sanlock) | Информация о пакете sanlock | ### Описание структуры libvirt_bin | Параметр | Тип | Описание | diff --git a/06.02.34-Data-функция-decort_cb_stack_list-получение-информации-о-stack_list.md b/06.02.34-Data-функция-decort_cb_stack_list-получение-информации-о-stack_list.md index 619cbf3..a004c84 100644 --- a/06.02.34-Data-функция-decort_cb_stack_list-получение-информации-о-stack_list.md +++ b/06.02.34-Data-функция-decort_cb_stack_list-получение-информации-о-stack_list.md @@ -46,15 +46,15 @@ _Data source_ функция **decort_cb_stack_list** принимает сле | type | string | Тип stack | ### Описание структуры packages -| Параметр | Тип | Описание | -|--------------------|-------------------------------------------------------------|----------------------------------------| -| libvirt_bin | []Struct [см. ниже](#описание-структуры-libvirt_bin) | Информация о пакете libvirt_bin | -| libvirt_daemon | []Struct [см. ниже](#описание-структуры-libvirt_daemon) | Информация о пакете libvirt_daemon | -| lvm2_lockd | []Struct [см. ниже](#описание-структуры-lvm2_lockd) | Информация о пакете lvm2_lockd | -| openvswitch_common | []Struct [см. ниже](#описание-структуры-openvswitch_common) | Информация о пакете openvswitch_common | -| openvswitch_switch | []Struct [см. ниже](#описание-структуры-openvswitch_switch) | Информация о пакете openvswitch_switch | -| qemu_system_x86 | []Struct [см. ниже](#описание-структуры-qemu_system_x86) | Информация о пакете qemu_system_x86 | -| sanlock | []Struct [см. ниже](#описание-структуры-sanlock) | Информация о пакете sanlock | +| Параметр | Тип | Описание | +|--------------------|-----------------------------------------------------|----------------------------------------| +| libvirt_bin | Struct [см. ниже](#описание-структуры-libvirt_bin) | Информация о пакете libvirt_bin | +| libvirt_daemon | Struct [см. ниже](#описание-структуры-libvirt_daemon) | Информация о пакете libvirt_daemon | +| lvm2_lockd | Struct [см. ниже](#описание-структуры-lvm2_lockd) | Информация о пакете lvm2_lockd | +| openvswitch_common | Struct [см. ниже](#описание-структуры-openvswitch_common) | Информация о пакете openvswitch_common | +| openvswitch_switch | Struct [см. ниже](#описание-структуры-openvswitch_switch) | Информация о пакете openvswitch_switch | +| qemu_system_x86 | Struct [см. ниже](#описание-структуры-qemu_system_x86) | Информация о пакете qemu_system_x86 | +| sanlock | Struct [см. ниже](#описание-структуры-sanlock) | Информация о пакете sanlock | ### Описание структуры libvirt_bin | Параметр | Тип | Описание | diff --git a/06.02.44-Data-функция-decort_cb_vins_list_deleted-получение-информации-о-всех-удаленных-виртуальных-сетях.md b/06.02.44-Data-функция-decort_cb_vins_list_deleted-получение-информации-о-всех-удаленных-виртуальных-сетях.md index 096a126..3ac988d 100644 --- a/06.02.44-Data-функция-decort_cb_vins_list_deleted-получение-информации-о-всех-удаленных-виртуальных-сетях.md +++ b/06.02.44-Data-функция-decort_cb_vins_list_deleted-получение-информации-о-всех-удаленных-виртуальных-сетях.md @@ -18,40 +18,40 @@ _Data source_ функция **decort_cb_vins_list_deleted** принимает ## Возвращаемые значения В случае успешного выполнения _data source_ функция **decort_cb_vins_list_deleted** возвращает в указанную при вызове переменную, в поле _items_ массив, каждый элемент которого состоит из следующих параметров: -| Параметр | Тип | Описание | -|----------------------|------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------| -| vins_id | int | id vins | -| account_id | int | ID подписчика ("account"), которому принадлежит ViNS. | -| account_name | string | Имя подписчика ("account"), которому принадлежит ViNS. | -| created_by | string | Аккаунт, создавший vins | -| created_time | int | Время создания vins | -| default_gw | string | Шлюз по умолчанию | -| default_qos | []Struct [см. ниже](#описание-структуры-default_qos) | QOS по умолчанию | -| deleted_by | string | Пользователь, удаливший vins | -| deleted_time | int | Время удаления vins | -| description | string | Текстовое описание ViNS. | +| Параметр | Тип | Описание | +|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| vins_id | int | id vins | +| account_id | int | ID подписчика ("account"), которому принадлежит ViNS. | +| account_name | string | Имя подписчика ("account"), которому принадлежит ViNS. | +| created_by | string | Аккаунт, создавший vins | +| created_time | int | Время создания vins | +| default_gw | string | Шлюз по умолчанию | +| default_qos | Struct [см. ниже](#описание-структуры-default_qos) | QOS по умолчанию | +| deleted_by | string | Пользователь, удаливший vins | +| deleted_time | int | Время удаления vins | +| description | string | Текстовое описание ViNS. | | external_ip | string | Внешний ip - адрес | -| gid | int | GRID ID | -| guid | int | ID ресурса | -| lock_status | string | Статус доступности | -| manager_id | int | Manager id | -| manager_type | string | Type of manager | -| milestones | int | Вехи | -| name | string | Имя ViNS. | -| netmask | int | Маска сети | -| network | string | Информация о сети | -| pre_reservations_num | int | Кол-во зарезервированных ip адресов | +| gid | int | GRID ID | +| guid | int | ID ресурса | +| lock_status | string | Статус доступности | +| manager_id | int | Manager id | +| manager_type | string | Type of manager | +| milestones | int | Вехи | +| name | string | Имя ViNS. | +| netmask | int | Маска сети | +| network | string | Информация о сети | +| pre_reservations_num | int | Кол-во зарезервированных ip адресов | | pri_vnf_dev_id | int | ID внутренней сети для разработки | -| redundant | bool | Redudant | -| rg_id | int | Идентификатор ресурсной группы, на уровне которой создан ViNS. Для ViNS, существующих на уровне "account", данный параметр будет равен 0. | -| rg_name | string | Имя ресурсной группы | -| sec_vnf_dev_id | int | ID sec внутренней сети для разработки | -| status | string | Статус vins | -| updated_by | string | Кем был обновлен vins | -| updated_time | int | Время последнего обновления vins | -| user_managed | bool | Флаг, управляется ли пользователем | -| vnfs | []Struct [см. ниже](#описание-структуры-vnfs) | Список VNFs | -| vxlan_id | int | Идентификатор vxlan | +| redundant | bool | Redudant | +| rg_id | int | Идентификатор ресурсной группы, на уровне которой создан ViNS. Для ViNS, существующих на уровне "account", данный параметр будет равен 0. | +| rg_name | string | Имя ресурсной группы | +| sec_vnf_dev_id | int | ID sec внутренней сети для разработки | +| status | string | Статус vins | +| updated_by | string | Кем был обновлен vins | +| updated_time | int | Время последнего обновления vins | +| user_managed | bool | Флаг, управляется ли пользователем | +| vnfs | []Struct [см. ниже](#описание-структуры-vnfs) | Список VNFs | +| vxlan_id | int | Идентификатор vxlan | ### Описание структуры default_qos | Параметр | Тип | Описание | diff --git a/07.02.12-Resource-функция-decort_cb_vins-управление-виртуальными-сетевыми-сегментами.md b/07.02.12-Resource-функция-decort_cb_vins-управление-виртуальными-сетевыми-сегментами.md index f932727..f413d81 100644 --- a/07.02.12-Resource-функция-decort_cb_vins-управление-виртуальными-сетевыми-сегментами.md +++ b/07.02.12-Resource-функция-decort_cb_vins-управление-виртуальными-сетевыми-сегментами.md @@ -3,26 +3,26 @@ _Resource_ функция **decort_cb_vins** служит для управле ## Аргументы _Resource_ функция **decort_cb_vins** принимает следующие аргументы: -| Аргумент | Тип | Обязательный | Описание | -|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| --- |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| name | string | :heavy_check_mark: | Имя виртуального сетевого сегмента (ViNS), по которому требуется получить информацию. Имя не может быть пустым.
ViNS идентифицируется по комбинации имени и идентификатора ресурсной группы (`rg_id`) или подписчика (`account_id`).
Обратите внимание, что имя ViNS является уникальным в рамках "account" и ресурсной группы. | -| account_id | int | :heavy_check_mark: | ID аккаунта, в котором будет создан vins. Для создания vins должен быть указан или account_id, или rg_id. | -| rg_id | int | :heavy_check_mark: | Идентификатор ресурсной группы, в которой будет создан vins. Для создания vins должен быть указан или account_id, или rg_id. | -| ext_net_id | int | :x: | Идентификатор внешней сети, в которую должен быть подключён ViNS. ViNS, созданные на уровне "account", не могут иметь подключений к внешним сетям.
-1 – не подключаться к extnet;
0 – автоматический выбор;
1+ – extnet ID.
Значение по умолчанию -1. | -| ext_ip | string | :x: | IP внешней сети, относится только к extNetId >= 0 | -| ipcidr | string | :x: | IP CIDR, который требуется присвоить внутреннему сегменту данного ViNS.
Данный параметр не является обязательным и принимается во внимание только на стадии создания нового ViNS. Если он не задан, то платформа установит значение самостоятельно. | -| pre_reservations_num | int |:x:| Количество предварительно созданных резерваций. Значение по умолчанию 32. | -| gid | int |:x:| ID кластера | -| description | string |:x:| Текстовое описание vins. | -| reason | string |:x:| Причина создания/изменения vins. | -| routes | []Struct{
destination string;
netmask string;
gateway string
} |:x:| Список статических маршрутов. Элемент списка состоит из:
 
адреса сети назначения,
 
маски сети,
 
шлюза по умолчанию. | -|default_qos| []Struct{
in_rate int;
 
in_burst int;
 
e_rate int
} |:x:| Обновить значения QoS по умолчанию:
 
Внутренний трафик, Кбит
 
Burst внутреннего трафика, Кбит
 
Rate внешнего трафика, Кбит | -|enable| bool |:x:| Флаг включения внутренней сети | -|permanently| bool |:x:| Флаг для удаления ресурса vins без возможности восстановления. | -|force| bool |:x:| Флаг для принудительного удаления ресурса vins. | +| Аргумент | Тип | Обязательный | Описание | +|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------| --- |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| name | string | :heavy_check_mark: | Имя виртуального сетевого сегмента (ViNS), по которому требуется получить информацию. Имя не может быть пустым.
ViNS идентифицируется по комбинации имени и идентификатора ресурсной группы (`rg_id`) или подписчика (`account_id`).
Обратите внимание, что имя ViNS является уникальным в рамках "account" и ресурсной группы. | +| account_id | int | :heavy_check_mark: | ID аккаунта, в котором будет создан vins. Для создания vins должен быть указан или account_id, или rg_id. | +| rg_id | int | :heavy_check_mark: | Идентификатор ресурсной группы, в которой будет создан vins. Для создания vins должен быть указан или account_id, или rg_id. | +| ext_net_id | int | :x: | Идентификатор внешней сети, в которую должен быть подключён ViNS. ViNS, созданные на уровне "account", не могут иметь подключений к внешним сетям.
-1 – не подключаться к extnet;
0 – автоматический выбор;
1+ – extnet ID.
Значение по умолчанию -1. | +| ext_ip | string | :x: | IP внешней сети, относится только к extNetId >= 0 | +| ipcidr | string | :x: | IP CIDR, который требуется присвоить внутреннему сегменту данного ViNS.
Данный параметр не является обязательным и принимается во внимание только на стадии создания нового ViNS. Если он не задан, то платформа установит значение самостоятельно. | +| pre_reservations_num | int |:x:| Количество предварительно созданных резерваций. Значение по умолчанию 32. | +| gid | int |:x:| ID кластера | +| description | string |:x:| Текстовое описание vins. | +| reason | string |:x:| Причина создания/изменения vins. | +| routes | []Struct{
destination string;
netmask string;
gateway string
} |:x:| Список статических маршрутов. Элемент списка состоит из:
 
адреса сети назначения,
 
маски сети,
 
шлюза по умолчанию. | +|default_qos| Struct{
in_rate int;
 
in_burst int;
 
e_rate int
} |:x:| Обновить значения QoS по умолчанию:
 
Внутренний трафик, Кбит
 
Burst внутреннего трафика, Кбит
 
Rate внешнего трафика, Кбит | +|enable| bool |:x:| Флаг включения внутренней сети | +|permanently| bool |:x:| Флаг для удаления ресурса vins без возможности восстановления. | +|force| bool |:x:| Флаг для принудительного удаления ресурса vins. | |ip| []Struct{
 
type string;
 
ip_addr string;
 
mac string;
 
compute_id int;
 
reason string;
 
} |:x:| Создать/удалить резервирование DHCP на внутренней сети:
 
Тип резервирования (обязательный параметр структуры ip)
 
Используемый IP-адрес. Для типа "EXCLUDE" требуется непустая строка. Игнорируется для типов "DHCP" и "VIP".
 
MAC-адрес для связи с резервированием IP-адресов. Игнорируется для типа "EXCLUDE", непустая строка требуется для "DHCP" и "VIP"
 
ID виртуальной машины, связанной с этим резервированием типа "DHCP". Игнорируется для других типов.
 
Причина действия | -|nat_rule| []Struct{
int_ip string;
 
int_port int;
 
ext_port_start int;
 
ext_port_end int
 
proto string;
} |:x:| Добавить/удалить правило NAT (переадресации портов) для внутренней сети.
 
Внутренний IP-адрес (обязательный параметр структуры nat_rule)
 
Внутренний порт (обязательный параметр структуры nat_rule)
 
Внешний начальный порт (обязательный параметр структуры nat_rule)
 
Внешний конечный порт, Значение по умолчанию -1
 
Протокол: tcp или udp. Значение по умолчанию tcp. | -|vnfdev_start| bool |:x:| Флаг запуска основного виртуального маршрутизатора внутренней сети. | +|nat_rule| []Struct{
int_ip string;
 
int_port int;
 
ext_port_start int;
 
ext_port_end int
 
proto string;
} |:x:| Добавить/удалить правило NAT (переадресации портов) для внутренней сети.
 
Внутренний IP-адрес (обязательный параметр структуры nat_rule)
 
Внутренний порт (обязательный параметр структуры nat_rule)
 
Внешний начальный порт (обязательный параметр структуры nat_rule)
 
Внешний конечный порт, Значение по умолчанию -1
 
Протокол: tcp или udp. Значение по умолчанию tcp. | +|vnfdev_start| bool |:x:| Флаг запуска основного виртуального маршрутизатора внутренней сети. | |vnfdev_restart|bool|:x:| Флаг перезагрузки основного виртуального маршрутизатора внутренней сети. | |vnfdev_reset|bool|:x:| Флаг сброса основного виртуального маршрутизатора внутренней сети. | |vnfdev_redeploy|bool|:x:| Флаг повторного разворачивания основного виртуального маршрутизатора внутренней сети. | @@ -35,39 +35,39 @@ _Resource_ функция **decort_cb_vins** принимает следующи ## Возвращаемые значения В случае успешного выполнения _data source_ функция **decort_cb_vins** возвращает в указанную при вызове переменную следующие значения: -| Параметр | Тип | Описание | -|----------------------|------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------| -| vins_id | int | id vins | -| vnf_dev | []Struct [см. ниже](#описание-структуры-vnf_dev) | Виртуальный маршрутизатор внутренней сети | -| account_id | int | ID подписчика ("account"), которому принадлежит ViNS. | -| account_name | string | Имя подписчика ("account"), которому принадлежит ViNS. | -| created_by | string | Аккаунт, создавший vins | -| created_time | int | Время создания vins | -| default_gw | string | Шлюз по умолчанию | -| default_qos | []Struct [см. ниже](#описание-структуры-default_qos) | QOS по умолчанию | -| deleted_by | string | Пользователь, удаливший vins | -| deleted_time | int | Время удаления vins | -| description | string | Текстовое описание ViNS. | -| gid | int | GRID ID | -| guid | int | ID ресурса | -| lock_status | string | Статус доступности | -| manager_id | int | Manager id | -| manager_type | string | Type of manager | -| milestones | int | Вехи | -| name | string | Имя ViNS. | -| netmask | int | Маска сети | -| network | string | Информация о сети | -| pre_reservations_num | int | Кол-во зарезервированных ip адресов | -| redundant | bool | Redudant | -| rg_id | int | Идентификатор ресурсной группы, на уровне которой создан ViNS. Для ViNS, существующих на уровне "account", данный параметр будет равен 0. | -| rg_name | string | Имя ресурсной группы | -| sec_vnf_dev_id | int | ID sec внутренней сети для разработки | -| status | string | Статус vins | -| updated_by | string | Кем был обновлен vins | -| updated_time | int | Время последнего обновления vins | -| user_managed | bool | Флаг, управляется ли пользователем | -| vnfs | []Struct [см. ниже](#описание-структуры-vnfs) | Список VNFs | -| vxlan_id | int | Идентификатор vxlan | +| Параметр | Тип | Описание | +|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------| +| vins_id | int | id vins | +| vnf_dev | []Struct [см. ниже](#описание-структуры-vnf_dev) | Виртуальный маршрутизатор внутренней сети | +| account_id | int | ID подписчика ("account"), которому принадлежит ViNS. | +| account_name | string | Имя подписчика ("account"), которому принадлежит ViNS. | +| created_by | string | Аккаунт, создавший vins | +| created_time | int | Время создания vins | +| default_gw | string | Шлюз по умолчанию | +| default_qos | Struct [см. ниже](#описание-структуры-default_qos) | QOS по умолчанию | +| deleted_by | string | Пользователь, удаливший vins | +| deleted_time | int | Время удаления vins | +| description | string | Текстовое описание ViNS. | +| gid | int | GRID ID | +| guid | int | ID ресурса | +| lock_status | string | Статус доступности | +| manager_id | int | Manager id | +| manager_type | string | Type of manager | +| milestones | int | Вехи | +| name | string | Имя ViNS. | +| netmask | int | Маска сети | +| network | string | Информация о сети | +| pre_reservations_num | int | Кол-во зарезервированных ip адресов | +| redundant | bool | Redudant | +| rg_id | int | Идентификатор ресурсной группы, на уровне которой создан ViNS. Для ViNS, существующих на уровне "account", данный параметр будет равен 0. | +| rg_name | string | Имя ресурсной группы | +| sec_vnf_dev_id | int | ID sec внутренней сети для разработки | +| status | string | Статус vins | +| updated_by | string | Кем был обновлен vins | +| updated_time | int | Время последнего обновления vins | +| user_managed | bool | Флаг, управляется ли пользователем | +| vnfs | []Struct [см. ниже](#описание-структуры-vnfs) | Список VNFs | +| vxlan_id | int | Идентификатор vxlan | ### Описание структуры vnf_dev | Параметр | Тип | Описание | diff --git a/07.02.15-Resource-функция-decort_cb_extnet-управление-внешними-сетями.md b/07.02.15-Resource-функция-decort_cb_extnet-управление-внешними-сетями.md index 7eecd47..c1478e4 100644 --- a/07.02.15-Resource-функция-decort_cb_extnet-управление-внешними-сетями.md +++ b/07.02.15-Resource-функция-decort_cb_extnet-управление-внешними-сетями.md @@ -5,31 +5,31 @@ _Resource_ функция **decort_cb_extnet** служит для управл **Для того чтобы использовать данную Resource функцию требуются права администратора!** ## Аргументы -| Аргумент | Тип | Обязательный | Описание | -| --- |--------------------------------------------------------------| --- |-----------------------------------------------------------------------------------------| -| name | string | :heavy_check_mark: | Наименование внешней сети | -| gid | int | :heavy_check_mark: | ID платформы | -| ipcidr | string | :heavy_check_mark: | CIDR адресация | -| vlan_id | int | :heavy_check_mark: | ID виртуальной локальной сети | -| gateway | string | :x: | Опциональный IP шлюза | -| dns | []string | :x: | Список DNS адресов | -| ntp | []string | :x: | Список NTP адресов | -| check_ips | []string | :x: | IP адреса для проверки доступности сети | -| virtual | bool | :x: | При значении true DHCP сервер **не** будет создан | -| desc | string |:x: | Текстовое опиание внешней сети | -| start_ip | string | :x: | Начало диапазона включенных IP адресов | -| end_ip | string | :x: | Конец диапазона включенных IP адресов | -| vnfdev_ip | string | :x: | IP адрес для VNFDev | -| pre_reservations_num | int | :x: | Кол-во резерваций | -| ovs_bridge | string | :x: | Наименование моста OpenvSwitch внешней сети | -| enable | bool | :x: | Включить/Выключить внешнюю сеть | -| set_default | bool | :x: | При значении true - внешняя сеть становится дефолтной на платформе (невозможно отменить) | -| excluded_ips | []string | :x: | Список исключенных IP адресов | +| Аргумент | Тип | Обязательный | Описание | +| --- |------------------------------------------------------------| --- |-----------------------------------------------------------------------------------------| +| name | string | :heavy_check_mark: | Наименование внешней сети | +| gid | int | :heavy_check_mark: | ID платформы | +| ipcidr | string | :heavy_check_mark: | CIDR адресация | +| vlan_id | int | :heavy_check_mark: | ID виртуальной локальной сети | +| gateway | string | :x: | Опциональный IP шлюза | +| dns | []string | :x: | Список DNS адресов | +| ntp | []string | :x: | Список NTP адресов | +| check_ips | []string | :x: | IP адреса для проверки доступности сети | +| virtual | bool | :x: | При значении true DHCP сервер **не** будет создан | +| desc | string |:x: | Текстовое опиание внешней сети | +| start_ip | string | :x: | Начало диапазона включенных IP адресов | +| end_ip | string | :x: | Конец диапазона включенных IP адресов | +| vnfdev_ip | string | :x: | IP адрес для VNFDev | +| pre_reservations_num | int | :x: | Кол-во резерваций | +| ovs_bridge | string | :x: | Наименование моста OpenvSwitch внешней сети | +| enable | bool | :x: | Включить/Выключить внешнюю сеть | +| set_default | bool | :x: | При значении true - внешняя сеть становится дефолтной на платформе (невозможно отменить) | +| excluded_ips | []string | :x: | Список исключенных IP адресов | |excluded_ips_range| []Struct [см. ниже](#описание-блока-excluded_ips_range-args) |:x:| Задать диапазон исключенных IP адресов | -|default_qos| []Struct [см. ниже](#описание-блока-default_qos-args) |:x: | Стандартные значения QOS | -| restart | bool | :x: | Флаг перезапуска сети | -|migrate| int | :x: |ID stack на который происходит миграция| -|shared_with| []int |:x:| Список id аккаунтов, которым предоставлен доступ к extnet | +|default_qos| Struct [см. ниже](#описание-блока-default_qos-args) |:x: | Стандартные значения QOS | +| restart | bool | :x: | Флаг перезапуска сети | +|migrate| int | :x: |ID stack на который происходит миграция| +|shared_with| []int |:x:| Список id аккаунтов, которым предоставлен доступ к extnet | ### Описание блока excluded_ips_range args | Аргумент | Тип | Обязательный | Описание | @@ -47,27 +47,27 @@ _Resource_ функция **decort_cb_extnet** служит для управл ## Возвращаемые значения В случае успешного выполнения _resource_ функция **decort_cb_extnet** возвращает в указанную при вызове переменную следующие значения: -| Параметр | Тип | Описание | -| --- |----------------------------------------------------| --- | -| ckey | string | CKey | -| meta | []string | Meta | -| default | bool | Является ли внешняя сеть дефолтной | -| default_qos | []Struct{} [см.ниже](#описание-блока-default_qos) | Стандартные значения QOS | -| free_ips | int | Кол-во свободных IP адресов | -| guid | int | ID внешней сети на платформе | -| extnet_id | int | ID внешней сети | -| milestones | int | Вехи | -| network_id | int | ID сети | -| pri_vnfdev_id | int | Pri_VNFDev ID | -| pre_reservations_num | int | Кол-во резерваций | -| ovs_bridge | string | Наименование моста OpenvSwitch внешней сети | -| shared_with | []int | ID объектов, использующих сеть | -| status | string | Статус внешней сети | -| vnfs | []Struct{} [см.ниже](#описание-блока-vnfs) | Список VNFs | -| excluded | []Struct{} [см.ниже](#описание-блока-excluded) | Список исключенных клиентов | -| network | string | Сеть | -| prefix | int | Префикс | -| routes | []Struct{} [см. ниже](#описание-структуры-routes) | Список статических маршрутов | +| Параметр | Тип | Описание | +| --- |--------------------------------------------------| --- | +| ckey | string | CKey | +| meta | []string | Meta | +| default | bool | Является ли внешняя сеть дефолтной | +| default_qos | Struct{} [см.ниже](#описание-блока-default_qos) | Стандартные значения QOS | +| free_ips | int | Кол-во свободных IP адресов | +| guid | int | ID внешней сети на платформе | +| extnet_id | int | ID внешней сети | +| milestones | int | Вехи | +| network_id | int | ID сети | +| pri_vnfdev_id | int | Pri_VNFDev ID | +| pre_reservations_num | int | Кол-во резерваций | +| ovs_bridge | string | Наименование моста OpenvSwitch внешней сети | +| shared_with | []int | ID объектов, использующих сеть | +| status | string | Статус внешней сети | +| vnfs | []Struct{} [см.ниже](#описание-блока-vnfs) | Список VNFs | +| excluded | []Struct{} [см.ниже](#описание-блока-excluded) | Список исключенных клиентов | +| network | string | Сеть | +| prefix | int | Префикс | +| routes | []Struct{} [см. ниже](#описание-структуры-routes) | Список статических маршрутов | | reservations | []Struct{} [см.ниже](#описание-блока-reservations) | Резервации | ### Описание блока default_qos