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

Примечание

Этот модуль является частью коллекции community.general collection (версия 9.5.0).

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

Для установки используйте: ansible-galaxy collection install community.general.

Для использования в playbook, укажите: community.general.scaleway_security_group.

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

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

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

Параметры

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

Атрибуты

Атрибут	Поддержка	Описание
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
  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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/scaleway_security_group_module.html