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

add audit data sources

loskutovanl
2023-11-24 13:16:32 +03:00
parent f63746462c
commit 926c007b07
4 changed files with 135 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
06.02.69-Data-функция-decort_cb_audit-получение-информации-о-событии-системы.md Normal file

@@ -0,0 +1,45 @@
Функция доступна в провайдере версии 4.5.1 и выше.
_Data source_ функция **decort_cb_audit** служит для получения информации об указанном событий системы, вызванном действиями пользователя.
## Аргументы
_Data source_ функция **decort_cb_audit** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
|------------|--------| --- | --- |
| audit_guid | string | :heavy_check_mark: | GUID события |
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_cb_audit** возвращает в указанную при вызове переменную следующие параметры:
| Параметр | Тип | Описание |
|--------------|--------|----------------------------------------|
| audit_guid | string | GUID события |
| apitask | string | apitask |
| args | string | Аргументы вызова |
| kwargs |string| Аргументы вызова |
| call | string | Какая команда была выполнена |
| guid | string | ID ресурса |
| remote_addr |string| Адрес, на который отправляются журналы |
| result |string| json строка ответа |
| responsetime | float | Время выполнения |
| status_code | int | Статус выполнения |
| tags | string | Тэги |
| timestamp | float | Точное время исполнения |
|timestamp_end|float| Время окончания исполнения |
| user | string | Кем была выполнена команда |
## Пример использования
Пример вызова _data source_ функции **decort_cb_audit**:
```terraform
data "decort_cb_audit" "audit" {
audit_guid = "abcdefg"
}
# Once the above directive completes, audit will be accessible as
# data.decort_cb_audit.audit
```
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT) и [пример](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/02.-Пример-работы)).
После успешного завершения такого вызова **decort_cb_audit** в переменной `data.decort_cb_audit.audit` будут сохранены возвращаемые значения.

49
06.02.70-Data-функция-decort_cb_audit_list-получение-информации-о-всех-событиях-системы.md Normal file

@@ -0,0 +1,49 @@
Функция доступна в провайдере версии 4.5.1 и выше.
_Data source_ функция **decort_cb_audit_list** служит для получения списка событий системы, вызванных действиями пользователя.
## Аргументы
_Data source_ функция **decort_cb_audit_list** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
|--------------|--------|--------------|---------------------------------------------------------------------------|
| timestamp_at | int | :x: | Отдает все события, созданные после определенного времени (unix timstamp) |
| timestamp_to | int | :x: | Отдает все события, созданные до определенного времени (unix timstamp) |
| user | string | :x: | Пользователь для выборки (Mongo RegExp supported) |
| call | string | :x: | Фильтр по команде, которая была выполнена |
| status_code | int | :x: | Фильтр по статусу выполнения запроса |
| page | int | :x: | Номер страниц |
| size | int | :x: | Размер страницы |
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_cb_audit_list** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров:
| Параметр | Тип | Описание |
|--------------|--------|----------------------------------------|
| call | string | Какая команда была выполнена |
| guid | string | ID ресурса |
| responsetime | float | Время выполнения |
| status_code | int | Статус выполнения |
| timestamp | float | Точное время исполнения |
| user | string | Кем была выполнена команда |
## Пример использования
Пример вызова _data source_ функции **decort_cb_audit_list**:
```terraform
data "decort_cb_audit_list" "audit_list" {
#timestamp_at = 123456
#timestamp_to = 123456
#user = "username"
#call = "/restmachine/cloudbroker/audit/list"
#status_code = 200
#page = 2
#size = 3
}
# Once the above directive completes, audit list will be accessible as
# data.decort_cb_audit_list.audit_list.items
```
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT) и [пример](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/02.-Пример-работы)).
После успешного завершения такого вызова **decort_cb_audit_list** в переменной `data.decort_cb_audit_list.audit_list.items` будут сохранены возвращаемые значения.

38
06.02.71-Data-функция-decort_cb_audit_linked_jobs-получение-списка-заданий-связанных-с-указанным-событием-системы.md Normal file

@@ -0,0 +1,38 @@
Функция доступна в провайдере версии 4.5.1 и выше.
_Data source_ функция **decort_cb_audit_linked_jobs** служит для получения списка заданий, связанных с указанным событием системы.
## Аргументы
_Data source_ функция **decort_cb_audit_linked_jobs** принимает следующие аргументы:
| Аргумент | Тип | Обязательный | Описание |
|------------|--------|--------------|---------------------------------------------------------------------------|
| audit_guid | string | :heavy_check_mark: | GUID события |
## Возвращаемые значения
В случае успешного выполнения _data source_ функция **decort_cb_audit_linked_jobs** возвращает в указанную при вызове переменную, в поле _items_, массив, каждый элемент которого состоит из следующих параметров:
| Параметр | Тип | Описание |
|--------------|-----|---------------------------------|
| cmd | string | Какая команда была выполнена |
| nid | int | ID узла |
| state | string | Состояние задания |
| time_create | int | Время создания задания |
| time_start | int | Время начала выполнения задания |
| time_stop | int | Точное окончания исполнения |
| timeout |int| Таймаут |
## Пример использования
Пример вызова _data source_ функции **decort_cb_audit_linked_jobs**:
```terraform
data "decort_cb_audit_linked_jobs" "lj" {
audit_guid = "abcdefg"
}
# Once the above directive completes, audit linked jobs will be accessible as
# data.decort_cb_audit_linked_jobs.lj.items
```
Данный пример подразумевает, что ранее по тексту tf-файла выполнена корректная инициализация провайдера (подробнее об инициализации Terraform провайдера DECORT см. соответствующий [раздел](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/04.02-Инициализация-Terraform-провайдера-DECORT) и [пример](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/02.-Пример-работы)).
После успешного завершения такого вызова **decort_cb_audit_linked_jobs** в переменной `data.decort_cb_audit_linked_jobs.lj.items` будут сохранены возвращаемые значения.

3
Home.md

@@ -183,6 +183,9 @@ Terraform провайдер для платформы DECORT с API верси
- [**decort_cb_disk_list_unattached**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.66-Data-функция-decort_cb_disk_list_unattached-получение-информации-о-неподключенных-дисках) - получение информации о неподключенных дисках
- [**decort_cb_disk_snapshot**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.67-Data-функция-decort_cb_disk_snapshot-получение-информации-о-снимке-состояния) - получение информации о снимке состояния
- [**decort_cb_disk_snapshot_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.68-Data-функция-decort_cb_disk_snapshot_list-получение-списка-снимков-состояния-диска) - получение списка снимков состояния диска
- [**decort_cb_audit**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.69-Data-функция-decort_cb_audit-получение-информации-о-событии-системы) - получение информации о событии системы
- [**decort_cb_audit_list**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.70-Data-функция-decort_cb_audit_list-получение-информации-о-всех-событиях-системы) - получение информации о всех событиях системы
- [**decort_cb_audit_linked_jobs**](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/06.02.71-Data-функция-decort_cb_audit_linked_jobs-получение-списка-заданий-связанных-с-указанным-событием-системы) - получение списка заданий связанных с указанным событием системы
-->
7. [Resource функции Terraform провайдера DECORT](https://repository.basistech.ru/BASIS/terraform-provider-decort/wiki/07.-Resource-функции-Terraform-провайдера-DECORT)