Модуль sensu.sensu_go.namespace – Управление именованными пространствами Sensu

Примечание

Этот модуль является частью коллекции sensu.sensu_go (версия 1.14.0).

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

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

Чтобы использовать его в книге задач, укажите: sensu.sensu_go.namespace.

Новая функция в sensu.sensu_go 1.0.0

Обзор
Требования
Параметры
См. также
Примеры
Значения возврата

Обзор

Создание, обновление или удаление именованного пространства Sensu.
Дополнительную информацию см. в документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/reference/rbac/#namespaces.

Требования

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

python >= 2.7

Параметры

Параметр	Комментарии
auth словарь	Параметры аутентификации. Можно определить каждый из них с помощью переменной среды.
api_key строка добавлено в sensu.sensu_go 1.3.0	Ключ API, который следует использовать при аутентификации. Если он не задан, будет проверено значение переменной среды SENSU_API_KEY. Заменяет параметры auth.user и auth.password. Дополнительную информацию о ключе API см. в официальной документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/.
ca_path путь добавлено в sensu.sensu_go 1.5.0	Путь к каталогу сертификатов CA, который следует использовать для проверки сертификата бэкенда. Если этот параметр не задан, модуль будет использовать каталог сертификатов CA, используемый Python. Также можно задать этот параметр через переменную среды SENSU_CA_PATH.
password строка	Пароль пользователя Sensu. Если он не задан, будет проверено значение переменной среды SENSU_PASSWORD. Этот параметр игнорируется, если задан параметр auth.api_key. Значение по умолчанию: `"P@ssw0rd!"`
url строка	Расположение API бэкенда Sensu. Если он не задан, будет проверено значение переменной среды SENSU_URL. Значение по умолчанию: `"http://localhost:8080"`
user строка	Имя пользователя для подключения к API Sensu. Если он не задан, будет проверено значение переменной среды SENSU_USER. Этот параметр игнорируется, если задан параметр auth.api_key. Значение по умолчанию: `"admin"`
verify логический тип добавлено в sensu.sensu_go 1.5.0	Флаг, управляющий проверкой сертификата. Если вы используете самозаверяющие сертификаты, можно установить этот параметр в `false`. Используйте этот параметр ТОЛЬКО в сценариях разработки! В производственной среде при использовании самозаверяющих сертификатов см. параметр auth.ca_path. Также можно задать этот параметр через переменную среды SENSU_VERIFY. Варианты: `false` `true` ← (значение по умолчанию)
name строка / обязательный	Имя ресурса Sensu. Это имя (в сочетании с именным пространством, если применимо) однозначно идентифицирует ресурс, над которым Ansible выполняет операции. Если ресурс с выбранным именем уже существует, модуль Ansible обновит его в соответствии со спецификацией в задаче. См. спецификацию атрибута метаданных name в документации upstream по адресу https://docs.sensu.io/sensu-go/latest/reference/ для получения дополнительной информации о допустимых именах и других ограничениях.
state строка	Целевое состояние объекта Sensu. Варианты: `"present"` ← (значение по умолчанию) `"absent"`

См. также

sensu.sensu_go.namespace_info: Список именованных пространств Sensu.

Примеры

- name: Create a new namespace
  sensu.sensu_go.namespace:
    name: production
    state: present

- name: Delete a namespace
  sensu.sensu_go.namespace:
    name: staging
    state: absent

Значения возврата

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

Ключ	Описание
object словарь	Объект, представляющий именованное пространство Sensu. Возвращается: успех Пример: `{"name": "default"}`

Авторы

Paul Arthur (@flowerysong)
Aljaz Kosir (@aljazkosir)
Miha Plesko (@miha-plesko)
Tadej Borovsak (@tadeboro)

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

© 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/sensu/sensu_go/namespace_module.html