Модуль community.general.scaleway_security_group — модуль управления группами безопасности Scaleway

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.general.scaleway_security_group.

Краткое описание
Требования
Параметры
Атрибуты
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль управляет группами безопасности в учетной записи Scaleway https://developer.scaleway.com.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

PyYAML (если используется profile)

Параметры

Параметр	Комментарии
api_timeout псевдонимы: timeout целое число	Тайм-аут HTTP-запроса к API Scaleway в секундах. По умолчанию: `30`
api_token псевдонимы: oauth_token строка	Токен OAuth Scaleway. Этот параметр обязателен, если не указан `profile`.
api_url псевдонимы: base_url строка	URL API Scaleway. По умолчанию: `"https://api.scaleway.com"`
description строка	Описание группы безопасности.
inbound_default_policy строка	Политика по умолчанию для входящего трафика. Варианты: `"accept"` `"drop"`
name строка / обязательный	Имя группы безопасности.
organization строка	Идентификатор организации. Необходимо указать ровно один из параметров `project` и `organization`.
organization_default логическое значение	Создать группу безопасности, которая будет использоваться по умолчанию. Варианты: `false` `true`
outbound_default_policy строка	Политика по умолчанию для исходящего трафика. Варианты: `"accept"` `"drop"`
profile псевдонимы: scw_profile строка добавлено в community.general 12.2.0	Профиль конфигурации в файле конфигурации, из которого загружается токен OAuth Scaleway; используется вместо `api_token`. Также можно задать `SCW_PROFILE`, чтобы использовать профиль конфигурации SCW CLI.
project строка добавлено в community.general 12.3.0	Идентификатор проекта. Необходимо указать ровно один из параметров `project` и `organization`.
query_parameters словарь	Список параметров, передаваемых в строке запроса. По умолчанию: `{}`
region строка / обязательный	Регион Scaleway (например, `par1`). Варианты: `"ams1"` `"EMEA-NL-EVS"` `"ams2"` `"ams3"` `"par1"` `"EMEA-FR-PAR1"` `"par2"` `"EMEA-FR-PAR2"` `"par3"` `"waw1"` `"EMEA-PL-WAW1"` `"waw2"` `"waw3"`
state строка	Указывает требуемое состояние группы безопасности. Варианты: `"absent"` `"present"` ← (по умолчанию)
stateful логическое значение / обязательный	Создать группу безопасности с отслеживанием состояния, которая разрешает входящий и исходящий трафик для установленных соединений. Варианты: `false` `true`
validate_certs логическое значение	Проверять SSL-сертификаты API Scaleway. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.general.scaleway добавлено в community.general 11.3.0	Используйте `group/community.general.scaleway` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля.
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: нет	В режиме сравнения возвращает сведения об изменениях (или о возможных изменениях в `check_mode`).

Примечания

Примечание

См. также документацию API: https://developer.scaleway.com/.
Если api_token не задан в модуле, можно использовать следующие переменные среды в порядке убывания приоритета: SCW_TOKEN, SCW_API_KEY, SCW_OAUTH_TOKEN или SCW_API_TOKEN.
Чтобы использовать другой api_url, можно также задать переменную среды SCW_API_URL.

Примеры

- name: Create a Security Group using a project ID
  community.general.scaleway_security_group:
    state: present
    region: par1
    name: security_group
    description: "my security group description"
    stateful: false
    inbound_default_policy: accept
    outbound_default_policy: accept
    organization_default: false
    project: 951df375-e094-4d26-97c1-ba548eeb9c42
  register: security_group_creation_task

- name: Create a Security Group in the default project using an organization ID (deprecated)
  community.general.scaleway_security_group:
    state: present
    region: par1
    name: security_group
    description: "my security group description"
    organization: 43a3b6c8-916f-477b-b7ec-ff1898f5fdd9
    stateful: false
    inbound_default_policy: accept
    outbound_default_policy: accept
    organization_default: false
  register: security_group_creation_task

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

Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
data словарь	Присутствует только при `state=present`. Возвращается: когда `state=present` Пример: `{"scaleway_security_group": {"description": "my security group description", "enable_default_security": true, "id": "0168fb1f-cc46-4f69-b4be-c95d2a19bcae", "inbound_default_policy": "accept", "name": "security_group", "organization": "43a3b6c8-916f-477b-b7ec-ff1898f5fdd9", "organization_default": false, "outbound_default_policy": "accept", "servers": [], "stateful": false}}`

Ключ

Описание

data

словарь

Присутствует только при state=present.

Возвращается: когда state=present

Пример: {"scaleway_security_group": {"description": "my security group description", "enable_default_security": true, "id": "0168fb1f-cc46-4f69-b4be-c95d2a19bcae", "inbound_default_policy": "accept", "name": "security_group", "organization": "43a3b6c8-916f-477b-b7ec-ff1898f5fdd9", "organization_default": false, "outbound_default_policy": "accept", "servers": [], "stateful": false}}

Авторы

Antoine Barbare (@abarbare)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/scaleway_security_group_module.html