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

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

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

<table>
  <tr>
    <th colspan="2">Параметр</th>
    <th>Тип</th>
    <th>Описание</th>
  </tr>
  <tr>
    <td colspan="2">
      <a name="access_group_id">
        access_group_id
      </a>
    </td>
    <td>
      (str)
    </td>
    <td>
      Идентификатор группы доступа.
    </td>
  </tr>
  <tr>
    <td colspan="2">
      <a name="comment">
        comment
      </a>
    </td>
    <td>
      (str)
    </td>
    <td>
      Комментарий группы доступа.
    </td>
  </tr>
  <tr>
    <td colspan="2">
      <a name="display_name">
        display_name
      </a>
    </td>
    <td>
      (str)
    </td>
    <td>
      Отображаемое имя группы доступа.
    </td>
  </tr>
 <tr>
    <td colspan="2">
      <a name="state">
        state
      </a>
    </td>
    <td>
      (str)
      <br>Значения:
      <br><code>present</code>
      <br><code>absent</code>
    </td>
    <td>
      Целевое состояние группы доступа.
      <br><code>present</code> - существует. Если отсутствует, будет создана.
      <br><code>absent</code> - отсутствует. Если существует, будет удалена.
      <br>Значение по умолчанию если объект не найден: <code>present</code>.
    </td>
  </tr>
</table>

## Возвращаемые значения
Модуль **decort_sdn_access_group** возвращает информацию о группе доступа в виде словаря `facts` со следующими ключами:

<table>
  <tr>
    <th colspan="2">
      Ключ
    </th>
    <th>
      Тип
      <br>данных
    </th>
    <th>
      Описание
    </th>
  </tr>
  <tr>
    <td colspan="2">
      comment
    </td>
    <td>
      str
    </td>
    <td>
      Комментарий группы доступа.
    </td>
  </tr>
  <tr>
    <td colspan="2">
      created_at
    </td>
    <td>
      str
    </td>
    <td>
      Дата и время создания в формате ISO 8601.
    </td>
  </tr>
  <tr>
    <td colspan="2">
      default_security_policy
    </td>
    <td>
      dict[str, any]
    </td>
    <td>
      Словарь, описывающий политику безопасности по умолчанию.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="1">
      access_group_id
    </td>
    <td>
      str
    </td>
    <td>
      Идентификатор группы доступа.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="1">
      default_acl_drop
    </td>
    <td>
      str
    </td>
    <td></td>
  </tr>
  <tr>
    <td></td>
    <td colspan="1">
      display_name
    </td>
    <td>
      str
    </td>
    <td>
      Отображаемое имя политики безопасности.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="1">
      id
    </td>
    <td>
      str
    </td>
    <td>
      Идентификатор политики безопасности.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="1">
      version_id
    </td>
    <td>
      int
    </td>
    <td>
      Идентификатор версии объекта.
    </td>
  </tr>
  <tr>
    <td colspan="2">
      display_name
    </td>
    <td>
      str
    </td>
    <td>
      Отображаемое имя группы доступа.
    </td>
  </tr>
  <tr>
    <td colspan="2">
      id
    </td>
    <td>
      str
    </td>
    <td>
      Идентификатор группы доступа.
    </td>
  </tr>
  <tr>
    <td colspan="2">
      net_object_access_group
    </td>
    <td>
      dict[str, any]
    </td>
    <td>
      Словарь, описывающий сетевой объект группы доступа.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="1">
      access_group_id
    </td>
    <td>
      str
    </td>
    <td>
      Идентификатор группы доступа.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="1">
      id
    </td>
    <td>
      str
    </td>
    <td>
      Идентификатор сетевого объекта.
    </td>
  </tr>
  <tr>
    <td></td>
    <td colspan="1">
      version_id
    </td>
    <td>
      int
    </td>
    <td>
      Идентификатор версии объекта.
    </td>
  </tr>
  <tr>
    <td colspan="2">
      updated_at
    </td>
    <td>
      str
    </td>
    <td>
      Дата и время последнего обновления в формате ISO 8601.
    </td>
  </tr>
</table>

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

### Получить основную информацию о группе доступа
```
- name: Example
  hosts: localhost
  tasks:
    - name: Get SDN access group info
      decort_sdn_access_group:
        # Параметры для авторизации упущены
        access_group_id: "{{ access_group_id }}"
```

### Создать
```
- name: Example
  hosts: localhost
  tasks:
    - name: Create SDN access group
      decort_sdn_access_group:
        # Параметры для авторизации упущены
        display_name: "{{ access_group_name }}"
        comment: "{{ access_group_comment }}"
        state: present
```

### Удалить
```
- name: Example
  hosts: localhost
  tasks:
    - name: Delete SDN access group
      decort_sdn_access_group:
        # Параметры для авторизации упущены
        access_group_id: "{{ access_group_id }}"
        state: absent
```