# Модуль decort_vm_folder_access
## Обзор модуля

Модуль **decort_vm_folder_access** предназначен для выполнения следующих действий над явно назначенными правами доступа пользователя или группы к папке виртуальных машин:
- **получить информацию** (см. [примеры](#получить-информацию))
- **выдать или изменить права доступа** (см. [параметр right](#right) и [примеры](#выдать-или-изменить-права-доступа))
- **отозвать назначенные права доступа** (см. [параметр state](#state) и [примеры](#отозвать-права-доступа))

## Параметры модуля
Ниже приведен список параметров для модуля **decort_vm_folder_access** (за исключением [общих параметров](./введение.md#общие-параметры-модулей)):

<table>
  <tr>
    <th colspan="1">
      Параметр
    </th>
    <th>
      Тип
    </th>
    <th>
      Описание
    </th>
  </tr>
  <tr>
    <td colspan="1">
      <a name="folder_id">
        folder_id
      </a>
    </td>
    <td>
      (int)
    </td>
    <td>
      Идентификатор папки виртуальных машин. Обязательный параметр.
    </td>
  </tr>
  <tr>
    <td colspan="1">
      <a name="right">
        right
      </a>
    </td>
    <td>
      (str)
      <br>Значения:
      <br><code>R</code>
      <br><code>RCX</code>
      <br><code>ARCXDU</code>
    </td>
    <td>
      Тип доступа. Обязательный при выдаче и изменении прав доступа.
    </td>
  </tr>
  <tr>
    <td colspan="1">
      <a name="state">
        state
      </a>
    </td>
    <td>
      (str)
      <br>Значения:
      <br><code>absent</code>
    </td>
    <td>
      Целевое состояние прав доступа.
      <br><code>absent</code> - назначенные права доступа отозваны или не предоставлены.
    </td>
  </tr>
  <tr>
    <td colspan="1">
      <a name="user">
        user
      </a>
    </td>
    <td>
      (str)
    </td>
    <td>
      Имя пользователя или группы. Обязательный параметр.
    </td>
  </tr>
</table>

## Возвращаемые значения

Модуль **decort_vm_folder_access** возвращает информацию о явно назначенных правах доступа в виде словаря `facts` со следующими ключами. Если записи нет, словарь пустой.

<table>
  <tr>
    <th colspan="1">
      Ключ
    </th>
    <th>
      Тип
      <br>данных
    </th>
    <th>
      Описание
    </th>
  </tr>
  <tr>
    <td colspan="1">
      explicit
    </td>
    <td>
      bool
    </td>
    <td>
      Признак явно назначенных прав доступа.
    </td>
  </tr>
  <tr>
    <td colspan="1">
      right
    </td>
    <td>
      str
    </td>
    <td>
      Тип доступа.
    </td>
  </tr>
  <tr>
    <td colspan="1">
      status
    </td>
    <td>
      str
    </td>
    <td>
      Статус доступа.
    </td>
  </tr>
  <tr>
    <td colspan="1">
      type
    </td>
    <td>
      str
    </td>
    <td>
      Тип записи ACL.
    </td>
  </tr>
  <tr>
    <td colspan="1">
      user_group_id
    </td>
    <td>
      str
    </td>
    <td>
      Имя пользователя или группы.
    </td>
  </tr>
</table>

## Примеры использования

### Получить информацию
```
- name: Example
  hosts: localhost
  tasks:
    - name: Get VM folder access info
      decort_vm_folder_access:
        # Параметры для авторизации упущены
        folder_id: "{{ folder_id }}"
        user: "{{ user_name }}"
```

### Выдать или изменить права доступа
```
- name: Example
  hosts: localhost
  tasks:
    - name: Grant VM folder access
      decort_vm_folder_access:
        # Параметры для авторизации упущены
        folder_id: "{{ folder_id }}"
        user: "{{ user_name }}"
        right: RCX
```

### Отозвать права доступа
```
- name: Example
  hosts: localhost
  tasks:
    - name: Revoke VM folder access
      decort_vm_folder_access:
        # Параметры для авторизации упущены
        folder_id: "{{ folder_id }}"
        user: "{{ user_name }}"
        state: absent
```