6.5 KiB
6.5 KiB
Модуль decort_sdn_access_group
Обзор модуля
Модуль decort_sdn_access_group предназначен для выполнения следующих действий над группами доступа:
- получить основную информацию (см. возвращаемые значения и примеры)
- создать (см. примеры)
- удалить (см. параметр state и примеры)
Параметры модуля
Ниже приведен список параметров для модуля decort_sdn_access_group (за исключением общих параметров):
| Параметр | Тип | Описание | |
|---|---|---|---|
| access_group_id | (str) | Идентификатор группы доступа. | |
| comment | (str) | Комментарий группы доступа. | |
| display_name | (str) | Отображаемое имя группы доступа. | |
| state |
(str)
Значения: present
absent
|
Целевое состояние группы доступа.
present - существует. Если отсутствует, будет создана.
absent - отсутствует. Если существует, будет удалена.
Значение по умолчанию если объект не найден: present.
|
|
Возвращаемые значения
Модуль decort_sdn_access_group возвращает информацию о группе доступа в виде словаря facts со следующими ключами:
| Ключ |
Тип
данных |
Описание | |
|---|---|---|---|
| comment | str | Комментарий группы доступа. | |
| created_at | str | Дата и время создания в формате ISO 8601. | |
| default_security_policy | dict[str, any] | Словарь, описывающий политику безопасности по умолчанию. | |
| access_group_id | str | Идентификатор группы доступа. | |
| default_acl_drop | str | ||
| display_name | str | Отображаемое имя политики безопасности. | |
| id | str | Идентификатор политики безопасности. | |
| version_id | int | Идентификатор версии объекта. | |
| display_name | str | Отображаемое имя группы доступа. | |
| id | str | Идентификатор группы доступа. | |
| net_object_access_group | dict[str, any] | Словарь, описывающий сетевой объект группы доступа. | |
| access_group_id | str | Идентификатор группы доступа. | |
| id | str | Идентификатор сетевого объекта. | |
| version_id | int | Идентификатор версии объекта. | |
| updated_at | str | Дата и время последнего обновления в формате ISO 8601. | |
Примеры использования
Получить основную информацию о группе доступа
- 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