Модуль community.general.scaleway_security_group_info – Сбор информации о доступных группах безопасности Scaleway

Примечание

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

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

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

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

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

Описание

Сбор информации о доступных группах безопасности Scaleway.

Параметры

Параметр	Комментарии
api_timeout aliases: timeout целое число	Таймаут HTTP-запроса к API Scaleway в секундах. По умолчанию: `30`
api_token aliases: oauth_token строка / обязательный	Токен Scaleway OAuth.
api_url aliases: base_url строка	URL API Scaleway. По умолчанию: `"https://api.scaleway.com"`
query_parameters словарь	Список параметров, передаваемых в строку запроса. По умолчанию: `{}`
region строка / обязательный	Регион Scaleway для использования (например, `par1`). Варианты: `"ams1"` `"EMEA-NL-EVS"` `"par1"` `"EMEA-FR-PAR1"` `"par2"` `"EMEA-FR-PAR2"` `"waw1"` `"EMEA-PL-WAW1"`
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: Gather Scaleway security groups information
  community.general.scaleway_security_group_info:
    region: par1
  register: result

- ansible.builtin.debug:
    msg: "{{ result.scaleway_security_group_info }}"

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

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

Ключ	Описание
scaleway_security_group_info список / элементы=словарь	Ответ от API Scaleway. Для более подробной информации см.: https://developers.scaleway.com/en/products/instance/api/. Возвращаемое значение: успех Пример: `{"scaleway_security_group_info": [{"description": "test-ams", "enable_default_security": true, "id": "7fcde327-8bed-43a6-95c4-6dfbc56d8b51", "name": "test-ams", "organization": "3f709602-5e6c-4619-b80c-e841c89734af", "organization_default": false, "servers": [{"id": "12f19bc7-108c-4517-954c-e6b3d0311363", "name": "scw-e0d158"}]}]}`

Ключ

Описание

scaleway_security_group_info

список / элементы=словарь

Ответ от API Scaleway.

Для более подробной информации см.: https://developers.scaleway.com/en/products/instance/api/.

Возвращаемое значение: успех

Пример: {"scaleway_security_group_info": [{"description": "test-ams", "enable_default_security": true, "id": "7fcde327-8bed-43a6-95c4-6dfbc56d8b51", "name": "test-ams", "organization": "3f709602-5e6c-4619-b80c-e841c89734af", "organization_default": false, "servers": [{"id": "12f19bc7-108c-4517-954c-e6b3d0311363", "name": "scw-e0d158"}]}]}

Авторы

Yanis Guenane (@Spredzy)
Remy Leone (@remyleone)

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

© 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_info_module.html