Spec-Zone.ru › Ansible

Модуль community.general.scaleway_container_namespace_info — получение информации о пространстве имен контейнеров Scaleway

Примечание

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

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

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

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

Добавлено в community.general 6.0.0

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

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

  • Этот модуль возвращает информацию о пространстве имен контейнеров в учетной записи 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"

name

string / обязательный

Имя пространства имен контейнеров.

profile

псевдонимы: scw_profile

string

добавлено в community.general 12.2.0

Профиль конфигурации в файле конфигурации, из которого загружается токен OAuth Scaleway; используется вместо api_token.

Также можно задать SCW_PROFILE, чтобы использовать профиль конфигурации SCW CLI.

project_id

string / обязательный

Идентификатор проекта.

query_parameters

dictionary

Список параметров, передаваемых в строке запроса.

По умолчанию: {}

region

string / обязательный

Используемый регион Scaleway (например, fr-par).

Варианты:

  • "fr-par"
  • "nl-ams"
  • "pl-waw"

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

Поддержка: full

Это действие не изменяет состояние.

Может выполняться в режиме 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: Get a container namespace info
  community.general.scaleway_container_namespace_info:
    project_id: '{{ scw_project }}'
    region: fr-par
    name: my-awesome-container-namespace
  register: container_namespace_info_task

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

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

Ключ

Описание

container_namespace

dictionary

Информация о пространстве имен контейнеров.

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

Пример: {"description": "", "environment_variables": {"MY_VAR": "my_value"}, "error_message": null, "id": "531a1fd7-98d2-4a74-ad77-d398324304b8", "name": "my-awesome-container-namespace", "organization_id": "e04e3bdc-015c-4514-afde-9389e9be24b0", "project_id": "d44cea58-dcb7-4c95-bff1-1105acb60a98", "region": "fr-par", "registry_endpoint": "", "registry_namespace_id": "", "secret_environment_variables": [{"key": "MY_SECRET_VAR", "value": "$argon2id$v=19$m=65536,t=1,p=2$tb6UwSPWx/rH5Vyxt9Ujfw$5ZlvaIjWwNDPxD9Rdght3NarJz4IETKjpvAU3mMSmFg"}], "status": "pending"}

Авторы

  • Guillaume MARTINEZ (@Lunik)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)
  • Обратиться за помощью
  • Сообщить об ошибке
  • Предложить новую функцию
  • Связь

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API