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

Примечание

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

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

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

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

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

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

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

Требования

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

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

Параметры

Параметр	Комментарии
api_timeout псевдонимы: timeout integer	Тайм-аут HTTP-запроса к API Scaleway в секундах. По умолчанию: `30`
api_token псевдонимы: oauth_token string	Токен OAuth Scaleway. Обязателен, если не указан `profile`.
api_url псевдонимы: base_url string	URL API Scaleway. По умолчанию: `"https://api.scaleway.com"`
profile псевдонимы: scw_profile string добавлено в community.general 12.2.0	Профиль конфигурации в файле конфигурации, из которого нужно загрузить токен OAuth Scaleway; используется вместо `api_token`. Также можно задать `SCW_PROFILE`, чтобы использовать профиль конфигурации SCW CLI.
query_parameters dictionary	Список параметров, передаваемых в строку запроса. По умолчанию: `{}`
region string / обязательный	Регион Scaleway (например, `par1`). Варианты: `"ams1"` `"EMEA-NL-EVS"` `"ams2"` `"ams3"` `"par1"` `"EMEA-FR-PAR1"` `"par2"` `"EMEA-FR-PAR2"` `"par3"` `"waw1"` `"EMEA-PL-WAW1"` `"waw2"` `"waw3"`
validate_certs boolean	Проверять 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	Поддержка: не применимо Это действие не изменяет состояние.	В режиме diff возвращает сведения об изменениях (или об изменениях, которые могут потребоваться в `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 list / elements=dictionary	Ответ API Scaleway. Подробные сведения см. на странице: https://developers.scaleway.com/en/products/instance/api/. Возвращается: success Пример: `[{"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

list / elements=dictionary

Ответ API Scaleway.

Подробные сведения см. на странице: https://developers.scaleway.com/en/products/instance/api/.

Возвращается: success

Пример: [{"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–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_info_module.html